Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 4 additions & 31 deletions docs/RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,7 @@
# Release Process

The following prompt template is used to drive a Maven Central release. Paste it into a new Claude Code session, fill in the three placeholders, and send it to perform a release.
The maintainer-facing release procedure is **centralized in the workspace repo**:
[`../workspace/workflows/release-process.md`](../workspace/workflows/release-process.md).

```
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`)* |
```
streambuffer is a single-module Maven project (one `pom.xml`, one `README.md` dependency
snippet), so the canonical procedure applies as-is β€” there is no repo-specific supplement.
Loading