From 19fb2e5cab515e43ae27c0b24ab54f35dbbc86c5 Mon Sep 17 00:00:00 2001 From: Ladislav Thon Date: Mon, 30 Sep 2024 12:51:17 +0200 Subject: [PATCH] Update the release procedure description --- RELEASE_PROCEDURE.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/RELEASE_PROCEDURE.md b/RELEASE_PROCEDURE.md index 0457f026..0cc1e5f9 100644 --- a/RELEASE_PROCEDURE.md +++ b/RELEASE_PROCEDURE.md @@ -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-` 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).