Skip to content

Commit 19fb2e5

Browse files
committed
Update the release procedure description
1 parent add7edc commit 19fb2e5

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

RELEASE_PROCEDURE.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
1-
# Release Procedure
1+
# Release procedure
22

3-
the `jandex` project relies on a GitHub action to create its release.
3+
The Jandex project relies on GitHub Actions to create a release.
44

5-
# Create a PR to prepare the release
5+
## Create a PR to prepare the release
66

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

99
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`).
1010

11-
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.
11+
This PR must be pushed to the [`smallrye/jandex`](https://github.com/smallrye/jandex) repository.
12+
Pushing it to a fork will not create a release.
1213

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

15-
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/).
16+
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/).
1617

1718
The GitHub action also creates [Release Notes](https://github.com/smallrye/jandex/releases) corresponding to the new tag.
19+
20+
## More information
21+
22+
There is more information about the release process in the [Release Process wiki page](https://github.com/smallrye/smallrye/wiki/Release-Process).

0 commit comments

Comments
 (0)