[Documentation] Document the release process in CLAUDE.md

Merged
DJ
4mo ago
+35-1

What

Adds a Releasing section to the root CLAUDE.md so 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)

  1. Bump version in gem/lib/ruby_ui.rb + regenerate gem/Gemfile.lock and docs/Gemfile.lock.
  2. Publish gem — gem build + gem push (account has MFA → OTP needed; verify gem owner).
  3. Reflect on the website via a [Release] vX.Y.Z PR against protected main (home hero badge, both lockfiles, mcp/data/registry.json rebuilt with rake mcp:build).
  4. Tag + GitHub release on the merge commit.

Also clarifies the now-stale "Don't" line about version bumps so it doesn't contradict the release flow.

Testing instructions

  • Read the rendered CLAUDE.md "Releasing" section; confirm the four steps and the SemVer guidance are accurate and the #releasing anchor link in Don'ts resolves.
  • Docs-only change — no code, no tests affected.

Summary by cubic

Adds a “Releasing” section to CLAUDE.md with a 5-step checklist to finish releases: bump RubyUI::VERSION and both lockfiles, publish the gem (MFA; verify gem owner), reflect the version on the website via a [Release] vX.Y.Z PR, tag and create the GitHub release, and share a prefilled X.com post link that uses the full X.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.