Skip to content

fix(release): stage README.md so the CDN pin bump is committed - #162

Merged
adnaan merged 1 commit into
mainfrom
fix-release-readme-staging
Nov 4, 2026
Merged

adnaan merged 1 commit into
mainfrom
fix-release-readme-staging

Conversation

@adnaan

@adnaan adnaan commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

scripts/release.sh updates the README's CDN pins in bump_version and includes README.md in its failure-restore list, but commit_and_tag only stages VERSION package.json package-lock.json CHANGELOG.md. As a result, every release leaves README.md modified on main, and the next release's clean-tree check refuses to run until someone commits it by hand. That happened with both v0.25.1 and v0.25.2.

  • scripts/release.sh: add README.md to the git add in commit_and_tag.
  • README.md: commit the pins left behind by the v0.25.2 release (0.20.0 → 0.25.2).

Tests: npm test: 897 passed, 1 skipped. bash -n scripts/release.sh succeeds. The real proof is the next release leaving a clean tree.

🤖 Generated with Claude Code

https://claude.ai/code/session_01H17jLWktjd8RmZim6vf8RJ

release.sh rewrites the README's CDN pins (bump_version) and restores
README.md on failure, but commit_and_tag's `git add` list left it out.
Every release therefore left README.md modified on main, and the next
release's clean-tree check refused to start until someone committed it.

Also commits the pins the v0.25.2 release left behind (0.20.0 -> 0.25.2).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01H17jLWktjd8RmZim6vf8RJ
@claude

claude Bot commented Nov 4, 2026

Copy link
Copy Markdown

Review: LGTM.

  • README CDN pins move from 0.20.0 to 0.25.2, which matches VERSION and package.json.
  • release.sh now stages README.md in commit_and_tag. This is needed because the script already rewrites the README pins with sed (around line 212), and the file is already in the dirty-tree check list (line 175). Without this change the bump would be left uncommitted.

I found no bugs or security issues. One optional follow-up: add a CI or lint check that the README pin equals VERSION, so the two can't drift apart again.

I read the diff and grepped the script. I did not run the release flow.

@adnaan
adnaan merged commit 406a219 into main Nov 4, 2026
7 checks passed
@adnaan
adnaan deleted the fix-release-readme-staging branch November 4, 2026 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant