ci(docs): run link gate in PR checks#8197
Open
Audacity88 wants to merge 1 commit into
Open
Conversation
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.
Summary
masterscripts/ci/docs_links_gate.shto the requireddocs-styleCI job so PRs exercise the changed-line docs link gate.collect_changed_links.pyso it can split HTTP(S) targets from source-relative docs targets and fail on missing source-relative files.lycheeis not provisioned, which keeps the required docs job self-contained.docs-stylelists both the quality gate and link gate.enhancement,risk: high,size: S,ci,docs,scriptsValidation Evidence (required)
Commands run and tail output:
Tail output:
Tail output:
Tail output:
Tail output:
Beyond CI — what did you manually verify? Verified the gate accepts existing source-relative links, rejects missing source-relative links, skips site-absolute generated API links, does not require
lycheein a CI-like PATH, and still useslychee --offlinewhen it is locally available.If any command was intentionally skipped, why: Full local
scripts/ci/docs_quality_gate.shmarkdownlint validation did not complete on this machine. The prose/em-dash portion passed, but the markdownlint step failed under the local Node 23/npm setup with an ESM/CJS package error; a Node 24npxretry failed in npm before running the gate. GitHubDocs Stylepassed on head7af0f31267, covering the required CI docs gate.Security & Privacy Impact (required)
NoNoNoNoYes, describe the risk and mitigation:N/ACompatibility (required)
YesYesNoorYesto either:collect_changed_links.pynow accepts optional--http-outputand--check-local-targetshelper flags. Existing--outputcallers still work; no user upgrade steps are required.Rollback (required for
risk: mediumandrisk: high)Docs link gate (added links)step from.github/workflows/ci.ymland restore the previous helper behavior.NoneDocs Stylejob fails on docs PRs, with logs such asBroken local docs link target(s):or unexpecteddocs_links_gate.shoutput.