Add comments for review around configuration section #1551
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@v3 | |
| # Workaround for MD links without extensions being detected as broken | |
| - 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@v3 | |
| with: | |
| path: .lycheecache | |
| key: cache-lychee-${{ github.ref_name }} | |
| restore-keys: cache-lychee- | |
| - name: Run lychee | |
| uses: lycheeverse/lychee-action@v1 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| args: "--accept 401,429 --cache --max-cache-age 1d --max-concurrency 64 --no-progress --verbose 'docs/**/*.md'" | |
| fail: true |