Skip to content

Commit 5684137

Browse files
committed
document the release process
Signed-off-by: Dave Nice <32769325+davenice@users.noreply.github.com>
1 parent 16a6304 commit 5684137

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

RELEASING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Releasing
2+
3+
## Prerequisites
4+
5+
- Write access to this repository
6+
- The current version on `main` must be a `-SNAPSHOT` version
7+
8+
## Steps
9+
10+
1. **Verify downstream projects** — before releasing, confirm the changes work correctly with [cics-bundle-maven](https://github.com/IBM/cics-bundle-maven) and [cics-bundle-gradle](https://github.com/IBM/cics-bundle-gradle) by updating their dependency to the current SNAPSHOT and running their builds locally.
11+
12+
2. **Trigger the release workflow** — go to Actions → Prepare Release → Run workflow, or run:
13+
```bash
14+
gh workflow run prepare-release.yml
15+
```
16+
This opens a PR that strips `-SNAPSHOT` from `pom.xml` (e.g. `2.0.5-SNAPSHOT → 2.0.5`).
17+
18+
3. **Review and merge the PR** — merging triggers the existing deploy to OSSRH via `maven-build.yml`.
19+
20+
4. **Publish to Maven Central** — a maintainer with Sonatype publishing permission must log in to [central.sonatype.com/publishing](https://central.sonatype.com/publishing) and publish the staged artifact.
21+
22+
5. **Automation takes over** — once the release PR is merged, `post-release.yml` automatically:
23+
- Creates a GitHub Release tagged `vX.Y.Z` with generated release notes
24+
- Opens a PR bumping to the next patch SNAPSHOT (e.g. `2.0.6-SNAPSHOT`)
25+
26+
6. **Merge the next-dev PR** — no rush, merge when ready.

0 commit comments

Comments
 (0)