ci: exclude Microsoft Store & VS Code links from lychee link check#1645
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot couldn't run its full agentic review because no GitHub Actions runner was available. Make sure your repository has a runner available to run Copilot's review, or add a copilot-setup-steps.yml file specifying one with the runs-on attribute. See the docs for more details.
Updates Lychee configuration to avoid CI failures caused by bot-blocked (403) but valid external links (Microsoft Store and VS Code).
Changes:
- Add
apps.microsoft.comto the Lycheeexcludelist to bypass Microsoft Store 403 responses. - Add
code.visualstudio.comto the Lycheeexcludelist to bypass VS Code site 403 responses.
Comment on lines
+32
to
+33
| "https://apps\\.microsoft\\.com", # Microsoft Store returns 403 to automated requests | ||
| "https://code\\.visualstudio\\.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.
Problem
The
Build & Verifyjob's Lychee link check (docs.yml→.lychee.toml) fails on three external links indocumentation/getting-started.htmlthat return 403 Forbidden to automated requests:https://apps.microsoft.com/store/detail/ubuntu/9PDXGNCFSCZVhttps://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701https://code.visualstudio.com/These are live, correct links — the Microsoft Store and VS Code sites simply bot-block the checker (a common link-checker false positive). The failure is unrelated to the doc content and recurs on every run.
Fix
Add the two hosts to the existing
excludelist in.lychee.toml, following the file's established pattern of host-specific excludes with an explanatory comment (as already done forolcf.ornl.gov→ 503,sc22.supercomputing.org→ 415, etc.).Targeted host excludes are preferred over globally accepting
403(which would mask genuinely dead links elsewhere in the docs).