Docs: exclude stackoverflow.com from lychee link check - #1701
Merged
Conversation
Stack Overflow returns 403 to automated requests, so the CUDA-version link in docs/documentation/docker.md fails the docs link check even though it resolves fine in a browser. Same class of exclusion already present for the Microsoft Store, VS Code, and OLCF Summit pages.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation link-check configuration (lychee) to avoid false CI failures caused by Stack Overflow returning 403 to automated requests.
Changes:
- Add
stackoverflow.comto the.lychee.tomlURL exclusion list so lychee skips those links.
| "https://www\\.olcf\\.ornl\\.gov/summit", # Returns 503 to automated requests | ||
| "https://apps\\.microsoft\\.com/store/detail/", # Microsoft Store detail pages return 403 to automated requests | ||
| "https://code\\.visualstudio\\.com/?$", # Root page returns 403 to automated requests | ||
| "https://stackoverflow\\.com", # Returns 403 to automated requests |
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.
Description
The docs link check fails on a Stack Overflow URL in
docs/documentation/docker.md:Stack Overflow returns 403 to automated requests. The link resolves fine in a
browser — it is not broken, it just refuses bots. This adds it to the existing
excludelist in.lychee.toml, alongside the entries already there for thesame reason (Microsoft Store, VS Code, OLCF Summit).
Scoped to the domain rather than the single question URL, since Stack Overflow
blocks bots site-wide and any future SO link would hit the same failure.
Type of change
Testing
Reproduced and verified locally with lychee 0.24.2 against a minimal HTML file
containing the failing URL:
[403] ... Rejected status code: 403 Forbidden— matches CI exactly0 Errors, 1 ExcludedAlso confirmed in CI: the same one-line change applied to the branch of #1628
turned the previously failing Documentation workflow green
(run 30662138744).
Checklist