1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
---
name: External documentation link health
on:
schedule:
- cron: "19 4 * * 3"
workflow_dispatch:
permissions:
contents: read
concurrency:
group: external-documentation-links-${{ github.ref }}
cancel-in-progress: false
jobs:
links:
name: Rate-limited external links
runs-on: ubuntu-24.04
timeout-minutes: 20
steps:
- name: Check out repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Restore successful link responses
uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
with:
path: .lycheecache
key: documentation-links-${{ runner.os }}-${{ github.run_id }}
restore-keys: |
documentation-links-${{ runner.os }}-
- name: Check external documentation links
uses: lycheeverse/lychee-action@e7477775783ea5526144ba13e8db5eec57747ce8 # v2.9.0
with:
args: >-
--config lychee.toml --root-dir '${{ github.workspace }}' --cache
'./**/*.md'
fail: true
token: ${{ secrets.GITHUB_TOKEN }}