action my broken link checker Скачать - action my broken link checker .

Действия GitHub: моя сломанная проверка ссылок ✔

Это действие GitHub для проверки сломанной ссылки в ваших статических файлах или в веб -страницах. Муффи используется для задачи проверки URL.

См. Пример базового действия GitHub для периодических проверок (еженедельно) против 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

Проверьте настоящую демонстрацию:

Это действие развертывания может сочетаться со статическими генераторами сайтов (Hugo, Mkdocs, Gatsby, Gitbook, Mdbook и т. Д.). Следующие примеры ожидают, что веб -страница сохранена в каталоге ./build . Во время тестов запускается веб -сервер Caddy, который использует имя хоста из параметра URL и обслуживает веб -страницы (см. Подробности в intrintpoint.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 Build? ОК, режим сценария также доступен:

- 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`	Параметры командной строки для Muffet URL
`INPUT_DEBUG`	ЛОЖЬ	Включить режим отладки для сценария `./entrypoint.sh` ( `set -x` )
`INPUT_PAGES_PATH`		Относительный путь к каталогу с локальными веб -страницами
`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

Лучшие практики

Давайте попробуем как можно больше автоматизировать создание веб -страниц.

Идеальная ситуация требует соглашения о именованиях репозитория, где название репозитория GitHub должно соответствовать URL, где он будет размещен.

Страницы GitHub с пользовательским доменом

Обязательной частью является имя репозитория awsug.cz , которое совпадает с доменом:

Имя репозитория: awsugcz/awsug.cz -> веб -страницы: https://awsug.cz

Веб -страницы будут храниться в виде страниц 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 с доменом github.io

Обязательной частью является имя репозитория k8s-harbor , которая является частью каталога в и ruzickap.github.io :

Название репозитория: ruzickap/k8s-harbor-> Веб-страницы: https://ruzickap.github.io/k8s-harbor

В примере веб -страницы будут использовать домен 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 для создания своей страницы.

Еще один пример при проверке веб -страницы локально хранясь на вашем диске. В этом случае я использую веб -страницу, созданную в каталоге ./tests/ из этого репозитория GIT:

 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 можно найти здесь: https://github.com/peaceiris/hactions-gh-pages/

Следующие ссылки содержит реальные примеры моей проверки сломанной ссылки:

Гуго-зерна
- Статическая страница, сгенерированная Hugo с проверенными ссылками: Hugo-build.yml
Vuepress-build-reploy
- Статическая страница, сгенерированная Vuepress с проверенными ссылками: vuepress-build-check-deploy.yml
Периодические проклятые проверки
- Периодическая проверка ссылок на веб-сайте xvx.cz с использованием: периодические разрывы-link-checks.yml

Расширять