Startseite>Ressourcen zum Erstellen von Websites>Website-Daten
Herunterladen

Github -Aktionen: Mein gebrochener Link -Checker ✔

Dies ist eine GitHub -Aktion, um den kaputten Link in Ihren statischen Dateien oder Webseiten zu überprüfen. Der Muffet wird für die URL -Überprüfungsaufgabe verwendet.

Siehe das Basic GitHub Action -Beispiel, um regelmäßige Schecks (wöchentlich) gegen mkdocs.org durchzuführen: 

 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

Schauen Sie sich die echte Demo an:

Diese Bereitstellungsaktion kann mit statischen Site -Generatoren (Hugo, Mkdocs, Gatsby, Gitbook, MDBook usw.) kombiniert werden. In den folgenden Beispielen wird erwartet, dass die Webseite in ein ./build -Verzeichnis speichert. Während der Tests wird ein Caddy -Webserver gestartet, der den Hostnamen aus dem URL -Parameter verwendet und die Webseiten bedient (siehe die Details in 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

Möchten Sie den Docker Build -Schritt überspringen? OK, der Skriptmodus ist auch verfügbar: 

- 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

Umgebungsvariablen, die von ./entrypoint.sh Skript verwendet werden.

Variable Standard Beschreibung
INPUT_CMD_PARAMS --buffer-size=8192 --max-connections=10 --color=always --verbose Befehlszeilenparameter für URL-Checker-Muffet
INPUT_DEBUG FALSCH Aktivieren Sie den Debug -Modus für das Skript ./entrypoint.sh ( set -x )
INPUT_PAGES_PATH Relativer Weg zum Verzeichnis mit lokalen Webseiten
INPUT_URL ( Obligatorisch / erforderlich ) URL, die überprüft wird

Beispiel für regelmäßige Überprüfungen

Pipeline für periodische Linküberprüfungen: 

 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 '

Vollständiges Beispiel

GitHub -Aktionsbeispiel: 

 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

Best Practices

Versuchen wir, das Erstellen der Webseiten so weit wie möglich zu automatisieren.

Die ideale Situation erfordert die Repository -Benennungskonvention, wobei der Name des Github -Repositorys mit der URL übereinstimmen sollte, in der sie gehostet wird.

Github -Seiten mit benutzerdefinierter Domain

Der obligatorische Teil ist der Repository -Name awsug.cz , der dem Domain entspricht:

  • Repository -Name: awsugcz/awsug.cz -> Webseiten: https://awsug.cz

Die Webseiten werden als Github -Seiten auf seiner eigenen Domain gespeichert.

Die GH -Aktionsdatei kann aussehen wie: 

 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

Das Beispiel verwendet Hugo.

Github -Seiten mit Github.io -Domäne

Der obligatorische Teil ist der Repository-Name k8s-harbor , der das Verzeichnisteil am und von ruzickap.github.io ist:

  • Repository-Name: Ruzickap/K8S-Harbor-> Webseiten: https://ruzickap.github.io/k8s-harborbor

Im Beispiel verwenden die Webseiten Githubs Domain 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

In diesem Fall verwende ich VuePress, um meine Seite zu erstellen.

Ein weiteres Beispiel bei der Überprüfung der auf Ihrer Festplatte lokal gespeicherten Webseite. In diesem Fall verwende ich die Webseite, die im Verzeichnis ./tests/ aus diesem Git -Repository erstellt wurde: 

 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

Ausgabe: 

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

Beispiele

Einige andere Beispiele für das Erstellen und Überprüfen von Webseiten mithilfe statischer Site-Generatoren und GitHub-Aktionen finden Sie hier: https://github.com/peaceiris/actions-gh-pages/

Die folgenden Links enthalten echte Beispiele für meinen gebrochenen Link -Checker:

  • Hugo-Build

    • Statische Seite, die von Hugo mit geprüften Links erzeugt wird: Hugo-build.yml

  • VuePress-Build-Check-Deploy

    • Statische Seite, die von VuePress mit geprüften Links erzeugt wird: VuePress-Build-Check Deploy.yml

  • periodisch gebrochene Link-Checks

    • Periodische Linküberprüfungen der XVX.Cz-Website mit: periodisch gebrochenen Link-Checks.yml
Expandieren
Zusätzliche Informationen
Ähnliche Anwendungen
Empfohlen für Sie
Ähnliche Nachrichten Alle