Beranda>Sumber daya pembuatan situs web>Data situs web
Unduh

Tindakan GitHub: Pemeriksa tautan saya yang rusak ✔

Ini adalah tindakan github untuk memeriksa tautan yang rusak di file statis atau halaman web Anda. Muffet digunakan untuk tugas pemeriksaan URL.

Lihat contoh tindakan gitub dasar untuk menjalankan pemeriksaan periodik (mingguan) terhadap mkdocs.org: 

 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

Lihat demo yang sebenarnya:

Tindakan penyebaran ini dapat dikombinasikan dengan generator situs statis (Hugo, MKDOCS, Gatsby, GitBook, MDBook, dll.). Contoh -contoh berikut mengharapkan halaman web disimpan di direktori ./build . Ada server web Caddy yang dimulai selama pengujian yang menggunakan nama host dari parameter URL dan melayani halaman web (lihat detail di 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

Apakah Anda ingin melewatkan langkah build docker? Oke, mode skrip juga tersedia: 

- 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

Parameter

Variabel lingkungan yang digunakan oleh ./entrypoint.sh Script.

Variabel Bawaan Keterangan
INPUT_CMD_PARAMS --buffer-size=8192 --max-connections=10 --color=always --verbose Parameter baris perintah untuk muffet checker url
INPUT_DEBUG PALSU Aktifkan mode debug untuk skrip ./entrypoint.sh ( set -x )
INPUT_PAGES_PATH Jalur relatif ke direktori dengan halaman web lokal
INPUT_URL ( Wajib / wajib ) URL yang akan diperiksa

Contoh cek berkala

Pipa untuk pemeriksaan tautan berkala: 

 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 '

Contoh lengkap

Contoh Tindakan 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

Praktik terbaik

Mari kita coba mengotomatiskan pembuatan halaman web sebanyak mungkin.

Situasi yang ideal membutuhkan konvensi penamaan repositori, di mana nama repositori GitHub harus cocok dengan URL di mana ia akan di -host.

Halaman gitub dengan domain khusus

Bagian wajib adalah nama repositori awsug.cz yang sama dengan domain:

  • Nama Repositori: AWSUGCZ/AWSUG.CZ -> Halaman Web: https://awsug.cz

Halaman web akan disimpan sebagai halaman github di domainnya sendiri.

File tindakan GH mungkin terlihat seperti: 

 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

Contohnya adalah menggunakan Hugo.

Halaman github dengan domain github.io

Bagian wajib adalah nama repositori k8s-harbor yang merupakan bagian direktori di dan ruzickap.github.io :

  • Nama Repositori: Ruzickap/K8s-Harbor-> Halaman Web: https://ruzickap.github.io/k8s-harbor

Dalam contoh halaman web akan menggunakan domain github.io GitHub. 

 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

Dalam hal ini saya menggunakan Vuepress untuk membuat halaman saya.

Contoh lain saat memeriksa halaman web yang disimpan secara lokal di disk Anda. Dalam hal ini saya menggunakan halaman web yang dibuat di ./tests/ direktori dari repositori git ini: 

 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

Keluaran: 

 *** 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...

Contoh

Beberapa contoh lain membangun dan memeriksa halaman web menggunakan generator situs statis dan tindakan github dapat ditemukan di sini: https://github.com/peaceiris/actions-ghh-pages/

Tautan berikut berisi contoh nyata dari Pemeriksa Tautan Rusak Saya:

  • Hugo-Build

    • Halaman statis yang dihasilkan oleh Hugo dengan tautan yang diperiksa: hugo-build.yml

  • Vuepress-build-check-Deploy

    • Halaman statis yang dihasilkan oleh vuepress dengan tautan terdaftar: vuepress-build-check-deploy.yml

  • Cek-cek-link berkala

    • Pemeriksaan Tautan Berkala dari Situs Web XVX.CZ Menggunakan: Periodik-Broken-Link-Checks.yml
Memperluas
Informasi Tambahan
Aplikasi Terkait
Direkomendasikan untuk Anda
Informasi Terkait Semua