Skip to content

Commit b42b0ae

Browse files
authored
Merge pull request #41 from VisLab/update_style
Updated the lychee action version
2 parents 7e83b47 + a039be7 commit b42b0ae

File tree

4 files changed

+70
-23
lines changed

4 files changed

+70
-23
lines changed

.github/workflows/links.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ jobs:
3939
4040
- name: Link Checker on built documentation
4141
id: lychee
42-
uses: lycheeverse/lychee-action@v2.1.0
42+
uses: lycheeverse/lychee-action@v2.6.1
4343
with:
4444
# Check the built HTML files recursively (includes internal links)
45-
args: --config .lycheeignore --base . --verbose --no-progress --max-redirects 10 'docs/_build/html/**/*.html'
45+
args: --config lychee.toml --base . --verbose --no-progress --max-redirects 10 'docs/_build/html/**/*.html'
4646
fail: true

.lycheeignore

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,42 @@
11
<!-- This file lists all links/regex to be ignored by lychee in the link checker -->
2+
# ScienceDirect links (require authentication/cookies)
23
https://www.sciencedirect.com/science/article/pii/S1053811921010387
34
https://www.sciencedirect.com/science/article/pii/S0010945221001106
45
https://www.sciencedirect.com/science/article/pii/S1388245717309069
6+
7+
# Springer links (503 Service Unavailable errors, but links work in browsers)
8+
^https?://link\.springer\.com/
9+
10+
# INCF links (certificate/network issues)
11+
^https?://.*\.incf\.org/
12+
^https?://incf\.org/
13+
14+
# DOI links that return 403 but work in browsers
15+
^https?://doi\.org/10\.1111/epi\.18113
16+
17+
# NPM package links (blocks automated requests)
18+
^https?://.*\.npmjs\.com/package/hed-validator
19+
20+
# MathWorks links (blocks automated requests)
21+
^https?://.*\.mathworks\.com/
22+
23+
# Brain Meeting poster links (expired/removed)
24+
^https?://brainmeeting.*\.ipostersessions\.com/
25+
^https?://globalbrainconsortium\.org/documents/GBC_March-2023_Agenda_Annual_Meeting\.pdf
26+
27+
# CANCTA network links (authentication/access issues)
28+
^https?://.*\.cancta\.net/
29+
^https?://cancta\.net/
30+
31+
# GitHub discussions (programmatic access blocked)
32+
^https?://github\.com/hed-standard/hed-python/discussions
33+
34+
# HED tools services (programmatic access blocked)
35+
^https?://hedtools\.org/hed/services_submit
36+
37+
# Neuroinformatics registration (certificate issues)
38+
^https?://neuroinformatics\.incf\.org/
39+
40+
# Internal anchor links (false positives from lychee)
541
(_anchor|-anchor)
642

lychee.toml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Lychee link checker configuration
2+
# This file configures how lychee validates links in the repository
3+
#
4+
# For more information about lychee configuration, see:
5+
# https://github.com/lycheeverse/lychee#configuration
6+
#
7+
# This configuration addresses false positive errors from the link checker:
8+
# - 403 Forbidden: Some sites (npmjs.com, mathworks.com, doi.org) block automated
9+
# requests but work fine in browsers
10+
# - 429 Too Many Requests: Rate limiting doesn't mean the link is broken
11+
# - See .lycheeignore for sites/patterns that are completely excluded
12+
13+
# Accept these HTTP status codes as valid
14+
# 200: OK (standard success)
15+
# 204: No Content (valid response with no body)
16+
# 206: Partial Content (valid for range requests)
17+
# 403: Forbidden (some sites block automated requests but links work in browsers)
18+
# 429: Too Many Requests (rate limiting, link may be valid)
19+
accept = [200, 204, 206, 403, 429]
20+
21+
# Timeout for requests (in seconds)
22+
timeout = 30
23+
24+
# Maximum number of retries per link
25+
max_retries = 3
26+
27+
# Maximum number of concurrent network requests
28+
max_concurrency = 8
29+
30+
# User agent string to use for requests
31+
# Some sites require a browser-like user agent to avoid blocking
32+
user_agent = "Mozilla/5.0 (X11; Linux x86_64; rv:100.0) Gecko/20100101 Firefox/100.0"

readthedocs.yml

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

0 commit comments

Comments
 (0)