Skip to content

Commit dc8c49b

Browse files
committed
Added lychee configs
1 parent 47b07f2 commit dc8c49b

3 files changed

Lines changed: 45 additions & 16 deletions

File tree

.github/lychee.toml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# For all options, see <https://lychee.cli.rs/usage/config/>
2+
3+
# Verbose program output
4+
# Accepts log level: "error", "warn", "info", "debug", "trace"
5+
verbose = "info"
6+
7+
# Interactive progress bar while checking links.
8+
# Disabled for CI usage
9+
no_progress = true
10+
11+
# Enable link caching. This can be helpful to avoid checking the same links on
12+
# multiple runs.
13+
cache = true
14+
15+
accept = [
16+
"200"
17+
]
18+
19+
# Maximum number of allowed redirects.
20+
max_redirects = 2
21+
22+
# Maximum number of allowed retries before a link is declared dead.
23+
max_retries = 2
24+
25+
# Only test links with the given schemes
26+
# Omit to check links with any other scheme.
27+
scheme = ["http", "https", "file"]
28+
29+
# Exclude links
30+
exclude = [
31+
# Exclude links as cookies needed to be accepted
32+
'https://developer.arm.com',
33+
'https://www.st.com/en/development-tools/hardware-debugger-and-programmer-tools-for-stm32/'
34+
]
35+
36+
# Exclude paths from getting checked. The values are treated as regular expressions
37+
exclude_path = [
38+
"\\.txt$", # skip .txt extensions
39+
"\\.html$", # skip .html extensions
40+
"test-data/", # skip directories named "test",
41+
"test-results/", # skip directories named "test",
42+
"test-workspace/", # skip directories named "test"
43+
]

.github/markdown-link-check.jsonc

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

.github/workflows/markdown.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,6 @@ jobs:
8080
- name: Check Links
8181
uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
8282
with:
83+
args: --config .github/lychee.toml './**/*.md'
8384
fail: true
85+
jobSummary: true

0 commit comments

Comments
 (0)