docs: stop the README from naming which release is current - #61
Merged
Conversation
Two sentences said which version was current, and both were wrong within a day of being written -- `4.1.0 is the current release` survived into 4.1.1. The npm badge at the top already renders the current version and is generated, so the prose was duplicating a fact it could not keep. Naming the line instead of the patch, as an earlier change did, only lengthens the interval: `4.1` goes stale at 4.2 and `4.x` at 5.0. Both sentences are gone instead, and the surrounding text says what does not move -- that 2.x continues on `v2-maintenance`, and that the CHANGELOG is where per-release detail lives. The versions that remain are requirements, which a reader does need, so they are pinned rather than removed: a new suite checks that the floors quoted in the documentation are the strings the manifest declares, that no other VS Code version is named anywhere, that `@types/vscode` has not drifted away from `engines.vscode`, and that no page claims to know which release is current. Verified against the text this replaces: restoring the previous README fails the last of those with both sentences named. The full suite is 1087 tests in 73 files. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013Tfbt5Vy1jB9C6mMAHXhLY
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.
Removes the two sentences that said which version was current, and pins the
versions that remain with a test.
Why
Both sentences were wrong within a day of being written:
`4.1.0` is the current release`4.1.0` is the current release and holds `latest` on npm4.1.1 shipped and neither moved. The npm badge at the top of the README already
renders the current version, and it is generated — so the prose was duplicating
a fact it had no way to keep.
An earlier change rewrote these to name the line (
4.1,4.x) instead of thepatch. That only lengthens the interval:
4.1goes stale at 4.2 and4.xat5.0. The sentences are gone instead. What is left says what does not move — that
2.xcontinues onv2-maintenance, and that the CHANGELOG is where per-releasedetail lives.
The versions that stay are requirements, so they are pinned
A reader deciding whether to adopt does need the floors. Those stay, and a new
suite holds them to the manifest:
enginesdeclares@types/vscodehas not drifted away fromengines.vscode— the README saysthe two move together, and this is that sentence as a check
This follows what
tests/readme-samples.test.tsalready does for documentedcode: the same argument, applied to the documented numbers.
Verification
Each assertion was checked by breaking what it guards and confirming it fails —
a test that only ever passes proves nothing:
1.133.0>=20.0.01.125.0added to the README@types/vscodeset to~1.120.0Full suite: 1087 tests in 73 files. No package content changes beyond the
README.
🤖 Generated with Claude Code