Skip to content

Commit aedee55

Browse files
authored
Update link checking (#294)
* Update link checking * Update to 0.20.1
1 parent 5d30174 commit aedee55

File tree

5 files changed

+49
-25
lines changed

5 files changed

+49
-25
lines changed

.github/config/lychee.toml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Lychee configuration file
2+
# See https://lychee.cli.rs/config/
3+
4+
timeout = 30
5+
retry_wait_time = 5
6+
max_retries = 6
7+
max_concurrency = 4
8+
9+
# Check link anchors
10+
include_fragments = true
11+
12+
remap = [
13+
# workaround for https://github.com/lycheeverse/lychee/issues/1729
14+
"https://github.com/(.*?)/(.*?)/blob/(.*?)/(.*#.*)$ https://raw.githubusercontent.com/$1/$2/$3/$4",
15+
]
16+
17+
exclude = [
18+
'^https://github.com/.*#discussion_r.*$',
19+
]

.github/workflows/build.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,10 +94,10 @@ jobs:
9494
exit 1
9595
fi
9696
97-
markdown-link-check:
97+
link-check:
9898
# release branches are excluded to avoid unnecessary maintenance
9999
if: ${{ !startsWith(github.ref_name, 'release/') }}
100-
uses: ./.github/workflows/reusable-markdown-link-check.yml
100+
uses: ./.github/workflows/reusable-link-check.yml
101101

102102
misspell-check:
103103
# release branches are excluded to avoid unnecessary maintenance
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Reusable - Link check
2+
3+
on:
4+
workflow_call:
5+
6+
permissions:
7+
contents: read
8+
9+
jobs:
10+
link-check:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
14+
15+
- name: Setup mise
16+
uses: jdx/mise-action@5ac50f778e26fac95da98d50503682459e86d566 # v3.2.0
17+
18+
- name: Run link check
19+
run: mise run link-check

.github/workflows/reusable-markdown-link-check.yml

Lines changed: 0 additions & 23 deletions
This file was deleted.

mise.toml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
[tools]
2+
lychee = "0.20.1"
3+
4+
[tasks.link-check]
5+
run = 'lychee --verbose --config .github/config/lychee.toml .'
6+
7+
[settings]
8+
# Only install tools explicitly defined in the [tools] section above
9+
idiomatic_version_file_enable_tools = []

0 commit comments

Comments
 (0)