[Documentation] Document the release process in CLAUDE.md#437
Merged
Conversation
cirdes
approved these changes
Jun 23, 2026
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.
What
Adds a Releasing section to the root
CLAUDE.mdso a release is never left half-finished (e.g. gem published but no git tag, or version not reflected on the website).Why
A recent release surfaced the gap: the gem was published to RubyGems before the git tag and the docs/website version reflection were done. The steps were tribal knowledge — now they're written down.
The documented checklist (all four required)
gem/lib/ruby_ui.rb+ regenerategem/Gemfile.lockanddocs/Gemfile.lock.gem build+gem push(account has MFA → OTP needed; verifygem owner).[Release] vX.Y.ZPR against protectedmain(home hero badge, both lockfiles,mcp/data/registry.jsonrebuilt withrake mcp:build).Also clarifies the now-stale "Don't" line about version bumps so it doesn't contradict the release flow.
Testing instructions
CLAUDE.md"Releasing" section; confirm the four steps and the SemVer guidance are accurate and the#releasinganchor link in Don'ts resolves.Summary by cubic
Adds a “Releasing” section to
CLAUDE.mdwith a 5-step checklist to finish releases: bumpRubyUI::VERSIONand both lockfiles, publish the gem (MFA; verifygem owner), reflect the version on the website via a[Release] vX.Y.ZPR, tag and create the GitHub release, and share a prefilled X.com post link that uses the fullX.Y.Z.Updates the Don’ts to align with this flow, link to the new section, and remove the hardcoded username from the gem owner check.
Written for commit eef3e8f. Summary will update on new commits.