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
43
44
45
name: Check broken links in docs
on:
pull_request:
branches:
- master
jobs:
check-broken-links-in-docs:
runs-on: ubuntu-latest
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: Check links in docs/*.md
uses: lycheeverse/lychee-action@v2
with:
fail: true
token: ${{ secrets.GITHUB_TOKEN }}
args:
# Notes:
# - Do not use `--base`. All relative URLs in Markdown are based on the file itself.
# - Verbosity level 2 enables debug logs and shows redirections.
# - Exclude dl.acm.org because it responses 403.
# According to the YAML syntax,
# the following lines will be concatenated into one single YAML string,
# which is intended because the `args:` argument of the lychee-action takes one single string.
--accept '200..=204,429,500'
--verbose --verbose
--no-progress
--cache
--max-cache-age 1d
--exclude 'https://users.cecs.anu.edu.au/~steveb/pubs/papers/**'
--exclude 'https://dl.acm.org/**'
'./docs/**/*.md'
- name: Save lychee cache
uses: actions/cache/save@v4
if: always()
with:
path: .lycheecache
key: ${{ steps.restore-cache.outputs.cache-primary-key }}