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
# Link checking for the documentation.
#
# The docs link heavily to GitHub's own guides and to this repository's own
# files, and a moved file breaks the second kind silently. The `links` job in
# .github/workflows/ci.yml runs this configuration.
# A link that is merely slow is not a broken link. Runners are shared and
# github.com rate-limits, so retry rather than fail the pull request.
= 3
= 3
= 20
# Hitting the same host from every document at once is what triggers the rate
# limiting in the first place.
= 8
# HEAD is cheaper, but several documentation sites answer it with 405.
= "get"
# An empty user agent is refused by some of the hosts the docs link to.
= "curl/8.0 (+https://github.com/BitKiln/GitBound)"
# Cache between runs so an unchanged link is not re-fetched on every push.
= true
= "2d"
# Anything that is not an error. 403 and 429 are included deliberately: sites
# that block or throttle CI egress return them for links that are perfectly
# valid in a browser, and treating that as breakage would fail the job for a
# reason no contributor can fix.
= ["200..=299", "403", "429"]
= [
# Addresses in examples, not real ones.
'^https?://(www\.)?example\.(com|org)',
]
= ["target"]