diff --git a/CHANGELOG.md b/CHANGELOG.md index bd87e0d7..89ec2545 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,43 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 --- +## Release Process + +> Paste this prompt into a new Claude Code session, fill in the three placeholders, and send it to perform a release. + +``` +Release `{PROJECT}` to Maven Central. + +**Step 1 — Prepare the release (do immediately):** +1. Read the current version from `pom.xml` on `main` — it will be `{VERSION}-SNAPSHOT` +2. Strip `-SNAPSHOT` from `pom.xml` (→ `{VERSION}`) +3. In `README.md`, update **both**: + - The release dependency example to `{VERSION}` + - The snapshot dependency example to `{VERSION}-SNAPSHOT` (it should already match, but verify) +4. Commit both files directly to `main` (no pull request) + +**Step 2 — Wait for manual confirmation:** +I will create the `v{VERSION}` tag and GitHub release manually — wait for me to confirm +the release is published on Maven Central before proceeding. + +**Step 3 — Post-release snapshot bump (after my confirmation):** +Bump **both** files on `main`: +- `pom.xml` → `{NEXT_VERSION}-SNAPSHOT` +- `README.md` snapshot dependency example → `{NEXT_VERSION}-SNAPSHOT` + +Commit both changes together directly to `main`. + +**Placeholders:** + +| Placeholder | Value | +|------------------|----------------------------------------------| +| `{PROJECT}` | *(project name)* | +| `{VERSION}` | *(release version, e.g. `1.3.0`)* | +| `{NEXT_VERSION}` | *(next snapshot base, e.g. `1.3.1`)* | +``` + +--- + ## [Unreleased] ### Added