added additonal notes to V3 #3256
Workflow file for this run
This file contains 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: Link Checker | |
| on: | |
| pull_request: | |
| branches: | |
| - docs-staging | |
| - master | |
| workflow_dispatch: | |
| jobs: | |
| test: | |
| name: Check for broken links | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| # Workaround for MD links without extensions being detected as broken | |
| # TODO Pass Lychee option "--fallback-extensions md" once it's available | |
| # See https://github.com/lycheeverse/lychee/pull/1422 | |
| - name: Create symlinks | |
| run: | | |
| find docs -name "*.md" -type f | while read f; do | |
| ln -s "$(basename "$f")" "${f%.*}" | |
| done | |
| - name: Restore lychee cache | |
| uses: actions/cache@v4 | |
| with: | |
| path: .lycheecache | |
| key: cache-lychee-${{ github.base_ref || github.ref_name }} | |
| restore-keys: cache-lychee- | |
| save-always: true | |
| - name: Run lychee | |
| uses: lycheeverse/lychee-action@v1 | |
| with: | |
| args: "--accept 403,406,429 --cache --include-fragments --max-cache-age 1d --max-concurrency 2 --no-progress --timeout 60 --verbose 'docs/**/*.md'" | |
| fail: true | |
| token: ${{ secrets.GITHUB_TOKEN }} |