ホーム>Web サイト構築リソース>ウェブサイトデータ
ダウンロード

GitHubアクション：私の壊れたリンクチェッカー✔

これは、静的ファイルまたはWebページの壊れたリンクを確認するためのGitHubアクションです。マフェットは、URLチェックタスクに使用されます。

Mkdocs.orgに対して定期的なチェック（毎週）を実行する基本的なGithubアクションの例を参照してください。 

 on :
  schedule :
    - cron : ' 0 0 * * 0 '

name : Check markdown links
jobs :
  my-broken-link-checker :
    name : Check broken links
    runs-on : ubuntu-latest
    steps :
      - name : Check
        uses : ruzickap/action-my-broken-link-checker@v2
        with :
          url : https://www.mkdocs.org
          cmd_params : " --one-page-only --max-connections=3 --color=always "  # Check just one page

本当のデモをチェックしてください：

この展開アクションは、静的サイトジェネレーター（Hugo、Mkdocs、Gatsby、Gitbook、Mdbookなど）と組み合わせることができます。次の例では./build buildディレクトリにWebページを保存することが期待されています。 URLパラメーターからホスト名を使用し、Webページを提供するテスト中に開始されたCaddy Webサーバーがあります（EntryPoint.shの詳細を参照）。 

- name : Check
  uses : ruzickap/action-my-broken-link-checker@v2
  with :
    url : https://www.example.com/test123
    pages_path : ./build/
    cmd_params : ' --buffer-size=8192 --max-connections=10 --color=always --skip-tls-verification --header="User-Agent:curl/7.54.0" --timeout=20 '  # muffet parameters

Dockerビルドステップをスキップしますか？わかりました、スクリプトモードも利用可能です。 

- name : Check
  env :
    INPUT_URL : https://www.example.com/test123
    INPUT_PAGES_PATH : ./build/
    INPUT_CMD_PARAMS : ' --buffer-size=8192 --max-connections=10 --color=always --header="User-Agent:curl/7.54.0" --skip-tls-verification '  # --skip-tls-verification is mandatory parameter when using https and "PAGES_PATH"
  run : wget -qO- https://raw.githubusercontent.com/ruzickap/action-my-broken-link-checker/v2/entrypoint.sh | bash

パラメーター

./entrypoint.shスクリプトで使用される環境変数。

変数デフォルト説明
INPUT_CMD_PARAMS --buffer-size=8192 --max-connections=10 --color=always --verbose URLチェッカーマフのコマンドラインパラメーター
INPUT_DEBUG間違い./entrypoint.shスクリプトのデバッグモードを有効にする（ set -x ）
INPUT_PAGES_PATHローカルWebページを備えたディレクトリへの相対パス
INPUT_URL （必須 /必須）チェックされるURL

定期的なチェックの例

定期的なリンクチェックのパイプライン： 

 name : periodic-broken-link-checks

on :
  workflow_dispatch :
  push :
    paths :
      - .github/workflows/periodic-broken-link-checks.yml
  schedule :
    - cron : ' 3 3 * * 3 '

jobs :
  broken-link-checker :
    runs-on : ubuntu-latest
    steps :

      - name : Setup Pages
        id : pages
        uses : actions/configure-pages@v3

      - name : Check broken links
        uses : ruzickap/action-my-broken-link-checker@v2
        with :
          url : ${{ steps.pages.outputs.base_url }}
          cmd_params : ' --buffer-size=8192 --max-connections=10 --color=always --header="User-Agent:curl/7.54.0" --timeout=20 '

完全な例

githubアクションの例： 

 name : Checks

on :
  push :
    branches :
      - main

jobs :
  build-deploy :
    runs-on : ubuntu-latest
    steps :
      - name : Create web page
        run : |
          mkdir -v public
          cat > public/index.html << EOF
          <!DOCTYPE html>
          <html>
            <head>
              My page which will be stored on my-testing-domain.com domain
            </head>
            <body>
              Links:
              <ul>
                <li><a href="https://my-testing-domain.com">https://my-testing-domain.com</a></li>
                <li><a href="https://my-testing-domain.com:443">https://my-testing-domain.com:443</a></li>
              </ul>
            </body>
          </html>
          EOF

      - name : Check links using script
        env :
          INPUT_URL : https://my-testing-domain.com
          INPUT_PAGES_PATH : ./public/
          INPUT_CMD_PARAMS : ' --skip-tls-verification --verbose --color=always '
          INPUT_DEBUG : true
        run : wget -qO- https://raw.githubusercontent.com/ruzickap/action-my-broken-link-checker/v2/entrypoint.sh | bash

      - name : Check links using container
        uses : ruzickap/action-my-broken-link-checker@v2
        with :
          url : https://my-testing-domain.com
          pages_path : ./public/
          cmd_params : ' --skip-tls-verification --verbose --color=always '
          debug : true

ベストプラクティス

Webページの作成を可能な限り自動化してみましょう。

理想的な状況には、GitHubリポジトリの名前がHOSTのURLと一致する必要があるリポジトリネーミング条約が必要です。

カスタムドメインを備えたgithubページ

必須の部分は、ドメインと同じであるリポジトリ名awsug.czです。

  • リポジトリ名：awsugcz/awsug.cz-> webページ：https：//awsug.cz

Webページは、独自のドメインにGitHubページとして保存されます。

GHアクションファイルは次のようになります。 

 name : hugo-build

on :
  pull_request :
    types : [opened, synchronize]
  push :

jobs :
  hugo-build :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/checkout@v2

      - name : Checkout submodules
        shell : bash
        run : |
          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
          git submodule sync --recursive
          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1

      - name : Setup Hugo
        uses : peaceiris/actions-hugo@v2
        with :
          hugo-version : ' 0.62.0 '

      - name : Build
        run : |
          hugo --gc
          cp LICENSE README.md public/
          echo "${{ github.event.repository.name }}" > public/CNAME

      - name : Check broken links
        env :
          INPUT_URL : https://${{ github.event.repository.name }}
          INPUT_PAGES_PATH : public
          INPUT_CMD_PARAMS : ' --verbose --buffer-size=8192 --max-connections=10 --color=always --skip-tls-verification --exclude="(mylabs.dev|linkedin.com)" '
        run : |
          wget -qO- https://raw.githubusercontent.com/ruzickap/action-my-broken-link-checker/v2/entrypoint.sh | bash

      - name : Check links using container
        uses : ruzickap/action-my-broken-link-checker@v2
        with :
          url : https://my-testing-domain.com
          pages_path : ./public/
          cmd_params : ' --verbose --buffer-size=8192 --max-connections=10 --color=always --skip-tls-verification --header="User-Agent:curl/7.54.0" --exclude="(mylabs.dev|linkedin.com)" '
          debug : true

      - name : Deploy
        uses : peaceiris/actions-gh-pages@v3
        if : ${{ github.event_name }} == 'push' && github.ref == 'refs/heads/main'
        env :
          ACTIONS_DEPLOY_KEY : ${{ secrets.ACTIONS_DEPLOY_KEY }}
          PUBLISH_BRANCH : gh-pages
          PUBLISH_DIR : public
        with :
          forceOrphan : true

例は、Hugoを使用することです。

github.ioドメインを備えたgithubページ

必須の部分は、 ruzickap.github.ioのディレクトリ部分であるリポジトリ名k8s-harborです。

  • リポジトリ名：ruzickap/k8s-harbor-> webページ：https：//ruzickap.github.io/k8s-harbor

この例では、WebページはGithubのドメインgithub.ioを使用します。 

 name : vuepress-build-check-deploy

on :
  pull_request :
    types : [opened, synchronize]
    paths :
      - .github/workflows/vuepress-build-check-deploy.yml
      - docs/**
      - package.json
      - package-lock.json
  push :
    paths :
      - .github/workflows/vuepress-build-check-deploy.yml
      - docs/**
      - package.json
      - package-lock.json

jobs :
  vuepress-build-check-deploy :
    runs-on : ubuntu-latest
    steps :
      - uses : actions/checkout@v2

      - name : Install Node.js 12
        uses : actions/setup-node@v1
        with :
          node-version : 12.x

      - name : Install VuePress and build the document
        run : |
          npm install
          npm run build
          cp LICENSE docs/.vuepress/dist
          sed -e "s@(part-@(https://github.com/${GITHUB_REPOSITORY}/tree/main/docs/part-@" -e 's@./.vuepress/public/@./@' docs/README.md > docs/.vuepress/dist/README.md
          ln -s docs/.vuepress/dist ${{ github.event.repository.name }}

      - name : Check broken links
        uses : ruzickap/action-my-broken-link-checker@v2
        with :
          url : https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}
          pages_path : .
          cmd_params : ' --exclude=mylabs.dev --max-connections-per-host=5 --rate-limit=5 --timeout=20 --header="User-Agent:curl/7.54.0" --skip-tls-verification '

      - name : Deploy
        uses : peaceiris/actions-gh-pages@v3
        if : ${{ github.event_name }} == 'push' && github.ref == 'refs/heads/main'
        env :
          ACTIONS_DEPLOY_KEY : ${{ secrets.ACTIONS_DEPLOY_KEY }}
          PUBLISH_BRANCH : gh-pages
          PUBLISH_DIR : ./docs/.vuepress/dist
        with :
          forceOrphan : true

この場合、VuePressを使用してページを作成しています。

ディスクにローカルに保存されているWebページをチェックするときの別の例。この場合、このgitリポジトリから./tests/ディレクトリで作成されたWebページを使用しています。 

 export INPUT_URL= " https://my-testing-domain.com "
export INPUT_PAGES_PATH= " ${PWD} /tests/ "
export INPUT_CMD_PARAMS= " --skip-tls-verification --verbose --color=always "
./entrypoint.sh

出力： 

 *** INFO: Using path "/home/pruzicka/git/action-my-broken-link-checker/tests/" as domain "my-testing-domain.com" with URI "https://my-testing-domain.com"
*** INFO: [2019-12-30 14:54:22] Start checking: "https://my-testing-domain.com"
https://my-testing-domain.com/
        200     https://my-testing-domain.com
        200     https://my-testing-domain.com/run_tests.sh
        200     https://my-testing-domain.com:443
        200     https://my-testing-domain.com:443/run_tests.sh
https://my-testing-domain.com:443/
        200     https://my-testing-domain.com
        200     https://my-testing-domain.com/run_tests.sh
        200     https://my-testing-domain.com:443
        200     https://my-testing-domain.com:443/run_tests.sh
*** INFO: [2019-12-30 14:54:22] Checks completed...

例

静的サイトジェネレーターとGitHubアクションを使用してWebページを構築およびチェックする他のいくつかの例は、https：//github.com/peceiris/actions-gh-pages/にあります。

次のリンクには、壊れたリンクチェッカーの実際の例が含まれています。

  • ヒューゴビルド

    • Hugoがチェックされたリンクを使用して生成した静的ページ：Hugo-Build.yml

  • vuepress-build-check-deploy

    • チェックされたリンクを使用してVuepressによって生成された静的ページ：Vuepress-Build-Check-Deploy.yml

  • 定期的な壊れたリンクチェック

    • XVX.CZの定期的なリンクチェックWebサイトを使用しています
拡大する
追加情報
関連アプリ
おすすめ
関連情報 すべて