Skip to content

Commit 1d27405

Browse files
authored
Add a link checker (#1776)
1 parent 81a11e2 commit 1d27405

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed

.github/workflows/links.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Links
2+
3+
on:
4+
pull_request:
5+
workflow_dispatch:
6+
7+
concurrency:
8+
group: ${{ github.workflow }}-${{ github.ref }}
9+
cancel-in-progress: true
10+
11+
jobs:
12+
check-links:
13+
name: Check Links
14+
runs-on: ubuntu-latest
15+
env:
16+
BUNDLE_JOBS: 3
17+
steps:
18+
- name: Clone repository
19+
uses: actions/checkout@v6
20+
21+
- name: Install Ruby
22+
uses: ruby/setup-ruby@v1
23+
with:
24+
bundler-cache: true
25+
26+
- name: Install Node
27+
uses: actions/setup-node@v6
28+
with:
29+
node-version-file: '.tool-versions'
30+
cache: yarn
31+
32+
- name: Install JS Deps
33+
run: yarn install --frozen-lockfile
34+
35+
- name: Compile site
36+
run: bundle exec rake compile
37+
38+
- name: Check links
39+
uses: lycheeverse/lychee-action@a8c4c7cb88f0c7386610c35eb25108e448569cb0 # v2
40+
with:
41+
args: '--root-dir ${{ github.workspace }}/output output/**/*.html'
42+
fail: true

.lychee.toml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Remap absolute support site URLs to relative paths for local file checking.
2+
# This lets lychee verify internal links against the compiled output
3+
# instead of hitting the live site.
4+
remap = [
5+
"https://support\\.dnsimple\\.com(.*) $1"
6+
]
7+
8+
exclude_mail = true
9+
max_concurrency = 5
10+
max_retries = 3
11+
timeout = 30

0 commit comments

Comments
 (0)