Skip to content

Commit fe03414

Browse files
authored
ci: add link-check workflow (lychee) (#16)
Same pattern as awesome-sentrix — lychee scans every markdown link on PR + push to main + a weekly Monday 03:00 UTC cron. Non-blocking, mirroring the gitleaks workflow's policy. Catches link rot between releases without gating merges. Co-authored-by: satyakwok <satyakwok@users.noreply.github.com>
1 parent eb48e01 commit fe03414

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

.github/workflows/link-check.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: link-check
2+
3+
# Lychee scans every markdown link in this repo so dead URLs surface
4+
# before users hit them. Runs on PR + push to main + a weekly cron so
5+
# rot is caught even between releases.
6+
#
7+
# Non-blocking on findings (matches the gitleaks workflow's policy) —
8+
# branch protection gates that the scan ran; results appear in the
9+
# workflow summary so an operator can decide whether to fix or accept.
10+
11+
on:
12+
pull_request:
13+
push:
14+
branches: [main]
15+
schedule:
16+
- cron: '0 3 * * 1' # Mondays 03:00 UTC
17+
workflow_dispatch:
18+
19+
permissions:
20+
contents: read
21+
22+
jobs:
23+
lychee:
24+
name: lychee (link check)
25+
runs-on: ubuntu-22.04
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
29+
30+
- name: Run lychee
31+
uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
32+
with:
33+
args: >-
34+
--no-progress
35+
--max-concurrency 8
36+
--exclude-mail
37+
--accept 200,206,403,429
38+
'**/*.md'
39+
fail: false

0 commit comments

Comments
 (0)