# 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 * * *' jobs: link-checker: runs-on: ubuntu-latest permissions: # lychee only uses the GITHUB_TOKEN to avoid rate-limiting contents: read steps: - uses: actions/checkout@v4 - name: Restore lychee cache uses: actions/cache@v3 with: path: .lycheecache key: cache-lychee-${{ github.sha }} restore-keys: cache-lychee- - name: Link Checker uses: lycheeverse/lychee-action@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}}