Reject retired versions in living docs - #44
Merged
Merged
Conversation
After CLI 0.8.0 shipped, the README and command reference still explained current behavior through CLI 0.2, 0.3, 0.4, and 0.6, and RELEASING.md still said "Before publishing CLI 0.8.0". In the 2026-09-29 documentation audit, model review caught none of the retired-phrase or census probes, so this drift needs a mechanical check. The documentation test reads the package version, the API range and Plan formats in release/compatibility.json, and the Rails profile that artifact validation accepts. Living pages may name only those identities. A version without an API or Plan label is checked as a CLI version. Otherwise the just-retired CLI line would pass whenever the API range still accepts it, as API 0.7.x does beside CLI 0.8.0. Living pages also may not call the package version a candidate, upcoming, pending, or unpublished release, or give a version a prerelease suffix. Dated release history is exempt. Each failure names the file, line, and identity, and says how to fix it. The sweep states current behavior without the old versions. Every scanned page ships in the package or routes agent work, so each hit is fixed rather than kept in a baseline.
npm audit fails on main and on every pull request: brace-expansion 5.0.9, which eslint reaches through minimatch, is affected by GHSA-q2hr-2g5m-vwhr, GHSA-qhr7-859c-m2p7 and GHSA-6j4f-fj2g-mc7p, published 2026-09-29. npm audit fix moves the lockfile to 5.0.12 within minimatch's existing range. It is a development dependency, so the published package does not change.
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
1 participant
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
Step 6 of the 2026-09-29 agent-documentation audit.
Currency test. A new test in
test/documentation.test.jsfails when living docs name a retired CLI version, Plan format, API range orrails-sketchprofile. It also fails on a release-status word ("candidate", "unreleased", "before publishing") next to the current package version.docs/**.docs/release-history.mdis dated history and is exempt.src/version.js,release/compatibility.jsonandRAILS_TARGET_PROFILE.Other changes.
docs/commands.mdversion-transition notes now state current behavior;brace-expansion5.0.12. Three advisories published 2026-09-29 against the version eslint reaches through minimatch brokenpm auditon main.npm audit fixupdates the lockfile within the existing range. This is a development dependency, so the package is unchanged.Docs: updated README, RELEASING, docs/commands.md and docs/README.md.
Validation
npm run check: 215/215npm audit: 0 vulnerabilitiesReview
cross-review 0.7.3 (
codex-review), max effort, with firstdraft'sdocs/review-focus.mdas the focus file. Round 1 found one medium issue: wrapped Markdown lines hid a release-status phrase. It was fixed with regression probes, and the delta round approved (sessiond14ae346-6b85-46bd-a11f-7972ff9a8214).