This repository was archived by the owner on Aug 7, 2025. It is now read-only.
feat: api documentation #164
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: Link Checker | |
| on: | |
| # This workflow requires pull_request and won't work with pull_request_target | |
| # due to github permissions | |
| pull_request: | |
| types: | |
| - opened | |
| - reopened | |
| - synchronize | |
| - closed | |
| # Uncomment the following lines to have the cronjob running daily | |
| #repository_dispatch: | |
| #workflow_dispatch: | |
| #schedule: | |
| #- cron: "00 18 * * *" | |
| jobs: | |
| link-check: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| issues: write # required for peter-evans/create-issue-from-file | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Link Checker | |
| id: lychee | |
| uses: lycheeverse/lychee-action@v2 | |
| with: | |
| args: -b . --verbose --no-progress --exclude '%23.*' './**/*.md' | |
| fail: true | |
| # Uncomment this if you want issues to be created for every dead link | |
| #- name: Create Issue From File | |
| #if: steps.lychee.outputs.exit_code != 0 | |
| #uses: peter-evans/create-issue-from-file@v5 | |
| #with: | |
| #title: Link Checker Report | |
| #content-filepath: ./lychee/out.md | |
| #labels: report, automated issue |