Skip to content

Conversation

jhlegarreta
Copy link
Member

Add link checker GHA workflow file: use the lychee action to check for broken links in Markdown, HTML, reStructuredText, and other files.

Repository: https://github.com/lycheeverse/lychee-action
Documentation: https://lychee.cli.rs/introduction/

PR Checklist

@github-actions github-actions bot added type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots type:Enhancement Improvement of existing methods or implementation labels May 31, 2025
@jhlegarreta
Copy link
Member Author

Not sure why it complains for the links to the commits in the release notes files.

@dzenanz
Copy link
Member

dzenanz commented Jun 2, 2025

Many failures are due to HTTP code 429: Network error: Too Many Requests. Can we slow down request rate or something similar?

Add link checker GHA workflow file: use the `lychee` action to check for
broken links in Markdown, HTML, reStructuredText, and other files.

Repository: https://github.com/lycheeverse/lychee-action
Documentation: https://lychee.cli.rs/introduction/
@jhlegarreta jhlegarreta force-pushed the AddLinkCheckerGHAWorkflow branch from ae36dc6 to cb55e14 Compare June 8, 2025 16:22
@jhlegarreta
Copy link
Member Author

jhlegarreta commented Jun 8, 2025

Looks like the limiting the rate of requests through caching does not work. Not sure if the cache has to be built first to have it working. Have gone through these
https://github.com/lycheeverse/lychee-action?tab=readme-ov-file#utilising-the-cache-feature
https://github.com/lycheeverse/lychee/blob/master/docs/TROUBLESHOOTING.md

but have not found how to modify the arguments to make throttling/request pace limiting work. Have seen other workflows accepting 429, e.g.

--accept 403,429,500,502,999

but I guess that will effectively not check the links at issue.

Also, checks will not work until this issue is solved:
lycheeverse/lychee#1574

I do not know any other tool that does this job for rst files. This one only seems to work for md files:
https://github.com/tcort/markdown-link-check

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:Enhancement Improvement of existing methods or implementation type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants