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 82c1e44 commit f70ef3d
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions RELEASE_PROCEDURE.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Release Procedure

the `smallrye/smallry-parent` 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 https://github.com/smallrye/smallrye-parent[`smallrye/smallry-parent`] 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 https://repo1.maven.org/maven2/io/smallrye/smallrye-parent/[Maven Central].


The GitHub action also creates https://github.com/smallrye/smallrye-parent/releases[Release Notes] corresponding to the new tag.

0 comments on commit f70ef3d

Please sign in to comment.