Internal Links Check #1184
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Internal Links Check | |
| on: | |
| pull_request: | |
| paths: | |
| - 'docs/**' | |
| - '**/*.md' | |
| - '.github/workflows/links-check.yml' | |
| permissions: | |
| contents: read | |
| jobs: | |
| linkChecker: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: read | |
| steps: | |
| - name: Check out repo | |
| uses: actions/checkout@v6 | |
| with: | |
| persist-credentials: false | |
| fetch-depth: 0 | |
| # It will be possible to check only for the links in the changed files | |
| # See: https://github.com/lycheeverse/lychee-action/issues/17 | |
| - name: Link Checker | |
| id: lychee | |
| uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # 2.8.0 | |
| with: | |
| fail: true | |
| # As external links behavior is not predictable, we check only internal links | |
| # to ensure consistency. | |
| # See: https://github.com/lycheeverse/lychee-action/issues/17#issuecomment-1162586751 | |
| args: --offline --verbose --no-progress './**/*.md' | |
| env: | |
| GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} | |
| - name: Collect changed markdown files | |
| id: changed-md | |
| run: | | |
| # docs/Guides/Ecosystem.md is checked by scripts/validate-ecosystem-links.js | |
| changed_files=$(git diff --name-only --diff-filter=ACMRT "${{ github.event.pull_request.base.sha }}" "${{ github.event.pull_request.head.sha }}" | grep -E '\.md$' | grep -v '^docs/Guides/Ecosystem\.md$' || true) | |
| if [ -z "$changed_files" ]; then | |
| echo "files=" >> "$GITHUB_OUTPUT" | |
| echo "No markdown files to check with linkinator." | |
| exit 0 | |
| fi | |
| files_as_space_list=$(echo "$changed_files" | tr '\n' ' ' | xargs) | |
| echo "files=$files_as_space_list" >> "$GITHUB_OUTPUT" | |
| echo "Checking markdown files: $files_as_space_list" | |
| - name: External Link Checker | |
| if: steps.changed-md.outputs.files != '' | |
| uses: JustinBeckwith/linkinator-action@f62ba0c110a76effb2ee6022cc6ce4ab161085e3 # 2.4.0 | |
| with: | |
| paths: ${{ steps.changed-md.outputs.files }} | |
| retry: true | |
| redirects: error | |
| linksToSkip: "https://github.com/orgs/fastify/.*" |