-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Jeff Mesnil <[email protected]>
- Loading branch information
Showing
1 changed file
with
20 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |