Skip to content

docs: add guide for patching and shipping older releases#866

Open
nathanklick wants to merge 1 commit into
mainfrom
docs/patch-release-guide
Open

docs: add guide for patching and shipping older releases#866
nathanklick wants to merge 1 commit into
mainfrom
docs/patch-release-guide

Conversation

@nathanklick

Copy link
Copy Markdown
Member

Summary

Adds docs/patch-release.md, a guide for back-porting a fix to an older release line and shipping a new patch version.

It documents:

  • The tag-driven release flow — the deploy workflow fires on any vX.Y.Z tag, derives the version from the tag name, and publishes to Maven Central + the Gradle Plugin Portal (non-prerelease tags only).
  • The no-release-branches caveat — all tags live on linear main, so patching means branching off the old tag.
  • Step-by-step commands — worked example patching off v0.14.5, including the version-collision gotcha (the new release must be v0.14.7 since v0.14.6 already exists), cherry-pick with -x -s, build verification, and tag/push to ship.
  • Notes on RC tags not publishing, manual GitHub Release creation, DCO sign-off, and the tag-push-triggers-real-publish warning.

Docs-only change.

🤖 Generated with Claude Code

Document the tag-driven release flow and the steps to back-port a fix
to an older release line (worked example: patching off v0.14.5).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Nathan Klick <nathan@swirldslabs.com>
@nathanklick nathanklick requested review from a team as code owners June 24, 2026 20:04
@nathanklick nathanklick requested a review from rbarker-dev June 24, 2026 20:04
@github-actions

Copy link
Copy Markdown

JUnit Test Report

   521 files  ±0     521 suites  ±0   30s ⏱️ ±0s
 1 537 tests ±0   1 533 ✅ ±0   4 💤 ±0  0 ❌ ±0 
10 755 runs  ±0  10 727 ✅ ±0  28 💤 ±0  0 ❌ ±0 

Results for commit 2344ed8. ± Comparison against base commit 925122f.

@github-actions

Copy link
Copy Markdown

Integration Test Report

    428 files  ±0      428 suites  ±0   20m 37s ⏱️ ±0s
115 048 tests ±0  115 048 ✅ ±0  0 💤 ±0  0 ❌ ±0 
115 292 runs  ±0  115 292 ✅ ±0  0 💤 ±0  0 ❌ ±0 

Results for commit 2344ed8. ± Comparison against base commit 925122f.

@andrewb1269

Copy link
Copy Markdown
Contributor

The commit on this PR is unverified.

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.

3 participants