fix(readme): pin install one-liner to v0.3.0 tag (#211) - #223
Merged
Conversation
The default install one-liner referenced the mutable dev branch, meaning the bytes a user executes are not the bytes any release was reviewed at. The pinned example still said v0.2.0 while package.json is 0.3.0. Both are corrected across all four language READMEs. Replacements in README.md, README.ko.md, README.ja.md, README.zh-CN.md: - Line 26: /dev/install.sh -> /v0.3.0/install.sh - Line 71: /v0.2.0/install.sh -> /v0.3.0/install.sh - Line 72: sh install.sh v0.2.0 -> sh install.sh v0.3.0 - Line 75: version=0.2.0 -> version=0.3.0 Ruled-out: referencing main instead of a tag | main is also mutable and does not name a reviewed release Ruled-out: leaving the pin at v0.2.0 until the next release | v0.3.0 is tagged and published; the mismatch with package.json is a documentation defect now, not a timing issue Limit: install.sh must already support tag-based download for the one-liner to work; verified that the URL resolves to a tagged tree Blast: local Undo: easy Certainty: firm Record-Id: r-pin030readme
CommitLore — record lintTrailers: clean — 1 commit in Active constraints for the paths this PR touchesLimits (23)
Ruled out (46)
Warnings (23)
Trailer violations fail this check. Active constraints are informational — they are what the repository already decided, not a verdict on this PR. |
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
Closes #211 (T-1031). The default install one-liner referenced the mutable
devbranch — a supply-chain exposure. The pinned example saidv0.2.0whilepackage.jsonis0.3.0.Changes
All four language READMEs (
README.md,README.ko.md,README.ja.md,README.zh-CN.md):/dev/install.sh→/v0.3.0/install.sh/v0.2.0/install.sh→/v0.3.0/install.shsh install.sh v0.2.0→sh install.sh v0.3.0version=0.2.0→version=0.3.0New test file
test/readme.test.tsasserts these invariants going forward.Verification
npx vitest run test/readme.test.ts: 12 passednpx vitest run: 46 files, 1512 passed, 1 skippednpx tsc -p tsconfig.json --noEmit: exit 0npx tsc -p bench/tsconfig.json --noEmit: exit 0node scripts/check-readme-numbers.mjs: exit 0 (BENCH block untouched)dist/drift