-
Notifications
You must be signed in to change notification settings - Fork 3.4k
v0.8.66: Make check-docs fail when install snippets are stale #3770
Copy link
Copy link
Open
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentationrelease-blockerMust be fixed before the next releaseMust be fixed before the next releasereliabilityReliability, flaky behavior, retries, fallbacks, and robustnessReliability, flaky behavior, retries, fallbacks, and robustnessv0.8.66Targeting v0.8.66Targeting v0.8.66
Milestone
Description
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentationrelease-blockerMust be fixed before the next releaseMust be fixed before the next releasereliabilityReliability, flaky behavior, retries, fallbacks, and robustnessReliability, flaky behavior, retries, fallbacks, and robustnessv0.8.66Targeting v0.8.66Targeting v0.8.66
Projects
StatusShow more project fields
In progress
Why this matters
npm run check:docsis a release/website parity gate. If it printsFAILfor stale install snippets but still exits successfully and printsPASS, CI can miss public install-copy drift. That undercuts the exact release-doc protection the gate is supposed to provide.Current behavior
web/scripts/check-docs.mjsdetects stale install snippets and prints a failure:web/scripts/check-docs.mjs:139-145But after printing the stale snippet details it does not call
process.exit(1). Control falls through to:web/scripts/check-docs.mjs:150Current clean run output still passes:
The bug is the stale-snippet failure path: if
install.okis false, the script reportsFAILbut does not exit non-zero.Desired behavior
check-docs.mjsexits non-zero.PASSafter anyFAILcondition.Repro or evidence
Inspect the control flow:
The stale-snippet branch logs
FAILand then falls through to the finalPASSline.Acceptance criteria
check-docs.mjsexits with status 1 whencheckInstallSnippets()returns stale entries.PASSis printed only if every check passed.cd web && npm run check:docsstill passes when snippets are fresh.Related