Link Checker #2286
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
| # This Link Checker is run on all documentation files once per week. | |
| # references: | |
| # - https://github.com/lycheeverse/lychee-action | |
| # - https://github.com/lycheeverse/lychee | |
| name: Link Checker | |
| on: | |
| push: | |
| branches: | |
| - develop | |
| - master | |
| pull_request: | |
| branches: | |
| - master | |
| workflow_dispatch: | |
| schedule: | |
| # * is a special character in YAML so you have to quote this string | |
| - cron: '30 8 * * *' | |
| permissions: # added using https://github.com/step-security/secure-repo | |
| contents: read | |
| jobs: | |
| link-checker: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| # lychee only uses the GITHUB_TOKEN to avoid rate-limiting | |
| contents: read | |
| steps: | |
| - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| - name: Restore lychee cache | |
| uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2 | |
| with: | |
| path: .lycheecache | |
| key: cache-lychee-${{ github.sha }} | |
| restore-keys: cache-lychee- | |
| - name: Link Checker | |
| uses: lycheeverse/lychee-action@c053181aa0c3d17606addfe97a9075a32723548a # v1.9.3 | |
| with: | |
| args: >- | |
| --config .github/lychee.toml | |
| packages/mermaid/src/docs/**/*.md | |
| README.md | |
| README.zh-CN.md | |
| fail: true | |
| jobSummary: true | |
| env: | |
| GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} |