CI: add lychee link check on built docs - #889
Merged
Merged
Conversation
Member
|
Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a
linksworkflow that runs https://github.com/lycheeverse/lychee against the rendered MkDocs output. Closes #473.Checking the built site instead of the markdown sources means links that only exist after rendering (magiclink shorthand, autorefs, mkdocstrings) are covered, which answers the question in #473 (comment).
site/404.htmlis excluded because MkDocs gives it root-relative/numtype/...links that only resolve on the deployed site.Tested locally with
uv run --only-group=docs mkdocs buildfollowed by lychee:🔍 273 Total (in 1s 582ms) 🔗 88 Unique ✅ 266 OK 🚫 0 Errors 👻 1 Excluded ⛔ 6 Unsupported 🔀 4 Redirects
The scheduled run won't fire on a fork PR, so this needs a
workflow_dispatchafter merge to see it in action.