Check for broken links #854
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: Check for broken links | |
| on: | |
| # Run daily at 9:00 AM | |
| schedule: | |
| - cron: '0 9 * * *' | |
| # Run on PRs to main | |
| pull_request: | |
| branches: [ main ] | |
| # Allow manual triggering | |
| workflow_dispatch: | |
| jobs: | |
| check-links: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v2 | |
| - name: Link Checker | |
| id: lychee | |
| uses: lycheeverse/lychee-action@v2.0.2 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| with: | |
| # Target all .yaml, .md, .ts and .vue files | |
| args: >- | |
| --verbose | |
| --no-progress | |
| --exclude-mail | |
| --exclude-loopback | |
| --exclude "file:///.*/issues.*" | |
| '**/*.yaml' | |
| '**/*.md' | |
| '**/*.ts' | |
| '**/*.vue' | |
| # Output file for creating issues | |
| output: ./lychee/out.md | |
| # Fail if any link is broken | |
| fail: true | |
| # Only create an issue when broken links are found AND running on schedule/manual | |
| - name: Create Issue (Only on schedule or manual run) | |
| if: ${{ failure() && (github.event_name == 'schedule' || github.event_name == 'workflow_dispatch') }} | |
| uses: peter-evans/create-issue-from-file@v4 | |
| with: | |
| title: Broken links detected | |
| content-filepath: ./lychee/out.md | |
| labels: broken-links |