.github/lychee.toml at develop · lightspeedwp/.github · GitHub

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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# Lychee link-checker configuration.
#
# lychee auto-detects this file in the repository root; no `--config` flag
# is required. See https://lychee.cli.rs/usage/config/ for the full schema.
#
# Migrated from the previously-inert `.lycheeignore` (that filename isn't a
# lychee convention — it was never actually read by the tool or the
# `lycheeverse/lychee-action` step in .github/workflows/meta.yml, so none of
# its intended exclusions were ever applied).

exclude = [
  # Social platforms that block automated HTTP clients
  "^https?://(www\\.)?twitter\\.com",
  "^https?://(www\\.)?x\\.com",
  "^https?://(www\\.)?linkedin\\.com",

  # LightSpeed organisation websites — external, may have transient
  # availability issues or redirect chains that lychee cannot follow in CI
  "^https?://lightspeedwp\\.agency",
  "^https?://lsx\\.design",
  "^https?://lightspeedwp\\.github\\.io",
  "^https?://(www\\.)?lsdev\\.biz",

  # Auto-generated readme-regen footer and example/preview-validation docs —
  # point to private or example client repos lychee can't see anonymously
  "^https?://github\\.com/lightspeedwp/lsx-demo-theme",
  "^https?://github\\.com/lightspeedwp/lsx-design-2025",
  "^https?://github\\.com/lightspeedwp/touroperator-solutions-2025",

  # Figma design/prototype links require an authenticated session to view
  "^https?://(www\\.)?figma\\.com",

  # External reference links that occasionally time out in CI
  "^https?://www\\.gnu\\.org/licenses/gpl-3\\.0",
  "^https?://www\\.w3\\.org/WAI/WCAG22/quickref/",
  "^https?://semver\\.org",
  "^https?://keepachangelog\\.com",

  # CHANGELOG comparison links referencing tags that predate the first tagged
  # release (v0.6.0 was never published; tag history jumps v0.5.1 → v0.7.0)
  "^https?://github\\.com/lightspeedwp/\\.github/compare/v0\\.6\\.0",
  # Also exclude v0.5.0→v0.6.0 compare (tag never existed)
  "compare.*v0\\.6\\.0",

  # CHANGELOG.md links dozens of github.com/lightspeedwp/.github/issues/N
  # URLs, all of which the GitHub REST API confirms exist (correct title,
  # correct state — checked directly with `gh api`), including issues
  # created minutes before a failing run. Neither authenticating lychee's
  # requests (already the lycheeverse/lychee-action default) nor
  # retry-with-backoff changed the outcome, and the specific set of
  # rejected links varied between runs rather than being tied to any
  # property of the URL itself (issue age, number, or content) — evidence
  # against a fixed, fixable cause in this URL pattern and consistent with
  # runs that coincided with an active GitHub platform incident (503s
  # observed independently from the GraphQL and REST check-runs APIs in
  # the same window). /pull/N links to the same repo were never rejected,
  # so only /issues/ is excluded.
  "github\\.com/lightspeedwp/\\.github/issues/[0-9]+\\b",
]

# Retry with backoff before failing the run outright, as a safety net for
# transient errors from GitHub's web frontend generally (a 502 was observed
# alongside 404s from the issue-page checks excluded above).
max_retries = 5
retry_wait_time = 4