Skip to content

Commit

Permalink
Add Release Procedure
Browse files Browse the repository at this point in the history
Signed-off-by: Jeff Mesnil <[email protected]>
  • Loading branch information
jmesnil committed Sep 26, 2024
1 parent 80e83e3 commit 88af5e9
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions RELEASE_PROCEDURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Release Procedure

the `jandex` project relies on a GitHub action to create its release.

# Create a PR to prepare the release

By convention, use a branch named `release-<x.y.z>` where `x.y.z` is the version that is about to be released.

The PR should only contain changes to the `.github/project.yml` file and specifies the version to release, and the next version to set in the POM (with a trailing `-SNAPSHOT`).

This PR must be pushed to the [`smallrye/jandex`](https://github.com/smallrye/jandex) repository. Pushing it to a fork will not create a release.

Once this PR is opened, it will check that it can be used to create a release.

Once merged, a GitHub action will update the project and and perform the release to deploy the artifacts in [Maven Central](https://repo1.maven.org/maven2/io/smallrye/jandex/).


# Update GitHub release notes

The GitHub action creates a tag corresponding to the release. We can then use GitHub UI to create release notes from this tag.

0 comments on commit 88af5e9

Please sign in to comment.