ci: add link checker #6
Workflow file for this run
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: Links | |
| on: | |
| repository_dispatch: | |
| workflow_dispatch: | |
| pull_request: | |
| schedule: | |
| - cron: "00 18 * * *" | |
| jobs: | |
| linkChecker: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| issues: write # required for peter-evans/create-issue-from-file | |
| steps: | |
| - uses: actions/checkout@v5 | |
| - name: Link Checker | |
| id: lychee | |
| uses: lycheeverse/lychee-action@v2 | |
| with: | |
| fail: false | |
| - name: Warn on broken links in PR | |
| if: steps.lychee.outputs.exit_code != 0 && github.event_name == 'pull_request' | |
| run: | | |
| echo "::warning::Link checker found broken links." | |
| if [ -f ./lychee/out.md ]; then | |
| echo "## 🔗 Link Checker Report" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| echo "The link checker found broken links in this pull request:" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| cat ./lychee/out.md >> $GITHUB_STEP_SUMMARY | |
| else | |
| echo "## 🔗 Link Checker Report" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| echo "The link checker found broken links. Please check the workflow logs for details." >> $GITHUB_STEP_SUMMARY | |
| fi | |
| - name: Create Issue From File | |
| if: steps.lychee.outputs.exit_code != 0 && github.event_name == 'schedule' | |
| uses: peter-evans/create-issue-from-file@v5 | |
| with: | |
| title: Link Checker Report | |
| content-filepath: ./lychee/out.md | |
| labels: 'type: documentation' |