Why this matters
prepare-release.sh and check-versions.sh are supposed to keep public release/install version surfaces aligned with the workspace version. Right now they can pass while public install snippets still point at the previous release. That makes the release gate look green while README or install docs tell users to verify/install the wrong version.
Current behavior
prepare-release.sh says it updates README install examples, but it only rewrites --tag vX.Y.Z examples in the translated READMEs:
scripts/release/prepare-release.sh:79-81
check-versions.sh has the matching guard, but it also only checks README --tag vX.Y.Z examples:
scripts/release/check-versions.sh:170-178
The adjacent public version snippets are not updated or guarded. On the current local 0.8.66 candidate branch, the README version comments are 0.8.66, but docs/INSTALL.md still contains 0.8.65 install/version copy while ./scripts/release/check-versions.sh passes:
README.md:36:codewhale --version # 0.8.66
README.zh-CN.md:23:codewhale --version # 0.8.66
README.ja-JP.md:20:codewhale --version # 0.8.66
README.vi.md:24:codewhale --version # 0.8.66
README.ko-KR.md:38:codewhale --version # 0.8.66
docs/INSTALL.md:129:npm is the recommended install path. The `codewhale` wrapper is published at
docs/INSTALL.md:130:v0.8.65 (Node 18+; wrapper available for v0.8.56 and later).
docs/INSTALL.md:134:codewhale --version # 0.8.65
The release check still reports:
Version state OK: workspace=0.8.66, npm=0.8.66, lockfile in sync.
There is prior evidence that this class of stale install reference already required a release end-cap fix:
Desired behavior
prepare-release.sh <version> updates codewhale --version # <version> snippets across README*.md and docs/INSTALL.md.
prepare-release.sh <version> updates the docs/INSTALL.md npm-wrapper sentence that says the wrapper is published at vX.Y.Z.
check-versions.sh fails when any guarded public install/version snippet is stale.
- The guard should cover the current README locales and
docs/INSTALL.md without becoming brittle about unrelated prose.
Repro or evidence
On the current local 0.8.66 candidate:
rg -n "codewhale --version\s*#|wrapper is published at|--tag v[0-9]+\.[0-9]+\.[0-9]+|0\.8\.65|0\.8\.66" README*.md docs/INSTALL.md docs/V0865_RELEASE_LEDGER.md
./scripts/release/check-versions.sh
The search shows docs/INSTALL.md still referencing 0.8.65, while check-versions.sh passes for workspace 0.8.66.
Acceptance criteria
Related
Why this matters
prepare-release.shandcheck-versions.share supposed to keep public release/install version surfaces aligned with the workspace version. Right now they can pass while public install snippets still point at the previous release. That makes the release gate look green while README or install docs tell users to verify/install the wrong version.Current behavior
prepare-release.shsays it updates README install examples, but it only rewrites--tag vX.Y.Zexamples in the translated READMEs:scripts/release/prepare-release.sh:79-81check-versions.shhas the matching guard, but it also only checks README--tag vX.Y.Zexamples:scripts/release/check-versions.sh:170-178The adjacent public version snippets are not updated or guarded. On the current local 0.8.66 candidate branch, the README version comments are 0.8.66, but
docs/INSTALL.mdstill contains 0.8.65 install/version copy while./scripts/release/check-versions.shpasses:The release check still reports:
There is prior evidence that this class of stale install reference already required a release end-cap fix:
docs/V0865_RELEASE_LEDGER.md:48notes PR docs: bump stale 0.8.64 version references to 0.8.65 (#3087) #3552 updated stale 0.8.64 install references to the workspace 0.8.65 line.Desired behavior
prepare-release.sh <version>updatescodewhale --version # <version>snippets acrossREADME*.mdanddocs/INSTALL.md.prepare-release.sh <version>updates thedocs/INSTALL.mdnpm-wrapper sentence that says the wrapper is published atvX.Y.Z.check-versions.shfails when any guarded public install/version snippet is stale.docs/INSTALL.mdwithout becoming brittle about unrelated prose.Repro or evidence
On the current local 0.8.66 candidate:
The search shows
docs/INSTALL.mdstill referencing0.8.65, whilecheck-versions.shpasses for workspace0.8.66.Acceptance criteria
prepare-release.sh 0.8.66updates READMEcodewhale --version # ...comments to0.8.66.prepare-release.sh 0.8.66updatesdocs/INSTALL.mdcodewhale --version # ...to0.8.66.prepare-release.sh 0.8.66updates thedocs/INSTALL.mdwrapper-published-at sentence tov0.8.66.check-versions.shfails if any of those snippets drift from the workspace version../scripts/release/check-versions.shpasses only after the public install docs are aligned.Related