-
Notifications
You must be signed in to change notification settings - Fork 94
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the release procedure description
- Loading branch information
Showing
1 changed file
with
10 additions
and
5 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 |
---|---|---|
@@ -1,17 +1,22 @@ | ||
# Release Procedure | ||
# Release procedure | ||
|
||
the `jandex` project relies on a GitHub action to create its release. | ||
The Jandex project relies on GitHub Actions to create a release. | ||
|
||
# Create a PR to prepare the 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. | ||
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/). | ||
Once merged, GitHub Actions will update the project and perform the release to deploy the artifacts in [Maven Central](https://repo1.maven.org/maven2/io/smallrye/jandex/). | ||
|
||
The GitHub action also creates [Release Notes](https://github.com/smallrye/jandex/releases) corresponding to the new tag. | ||
|
||
## More information | ||
|
||
There is more information about the release process in the [Release Process wiki page](https://github.com/smallrye/smallrye/wiki/Release-Process). |