الصفحة الرئيسية>موارد بناء الموقع>بيانات الموقع
تنزيل

إجراءات Github: مدقق الرابط المكسور الخاص بي ✔

هذا إجراء github للتحقق من الرابط المكسور في الملفات الثابتة أو صفحات الويب الخاصة بك. يتم استخدام Muffet لمهمة فحص 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 وخدمة صفحات الويب (انظر التفاصيل في Entploint.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 Checker Muffet
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 '

مثال كامل

مثال على عمل جيثب: 

 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 حيث سيتم استضافته.

صفحات جيثب مع مجال مخصص

الجزء الإلزامي هو اسم المستودع 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/actions-gh-pages/

تحتوي الروابط التالية على أمثلة حقيقية لمدقق الرابط المكسور الخاص بي:

  • Hugo-Build

    • صفحة ثابتة تم إنشاؤها بواسطة Hugo مع روابط محددة: Hugo-Build.yml

  • vuepress-build-check-deploy

    • صفحة ثابتة تم إنشاؤها بواسطة VuePress مع روابط محددة: Vuepress-Build-check-deploy.yml

  • شيكات الارتباط الدورية

    • شيكات الارتباط الدورية لموقع XVX.CZ باستخدام: checks.yml دورية.
يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل