-
Notifications
You must be signed in to change notification settings - Fork 0
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: Tero Saarni <[email protected]>
- Loading branch information
Showing
1 changed file
with
71 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,71 @@ | ||
# Release instructions | ||
|
||
This document describes the steps to create a new release of the project. | ||
|
||
### Tag the release in git | ||
|
||
Check that you have the `main` branch up to date with the remote repository: | ||
|
||
```bash | ||
git checkout main | ||
git pull | ||
``` | ||
|
||
Make sure that the working directory is clean: | ||
|
||
```console | ||
git status | ||
``` | ||
|
||
Update the release version in `pom.xml`, for example: | ||
|
||
```console | ||
mvn versions:set -DnewVersion=1.0.0 | ||
``` | ||
|
||
Run the tests once to make sure that everything is working: | ||
|
||
```console | ||
./mvnw clean verify | ||
``` | ||
|
||
Commit the version change: | ||
|
||
```console | ||
git add pom.xml && git commit -sm "Release v1.0.0" | ||
``` | ||
|
||
|
||
Create a new tag: | ||
|
||
```console | ||
git tag v1.0.0 | ||
``` | ||
|
||
Update the release version in `pom.xml` to the next snapshot version, for example: | ||
|
||
```console | ||
mvn versions:set -DnewVersion=1.1.0-SNAPSHOT | ||
``` | ||
|
||
Commit the version change: | ||
|
||
```console | ||
git add pom.xml && git commit -sm "Updated for next snapshot version" | ||
``` | ||
|
||
Push the changes to the remote repository: | ||
|
||
```console | ||
git push && git push --tags | ||
``` | ||
|
||
## Create release notes on GitHub | ||
|
||
Go to https://github.com/Nordix/keycloak-client-cert-lookup-for-envoy/releases and click "Draft a new release". | ||
|
||
1. Click "Choose a tag" and choose the tag that was pushed, for example `v1.0.0`. | ||
2. Add a title, for example "v1.0.0". | ||
3. Click "Generate release notes" to get the commit/change link. | ||
4. Update the release notes. | ||
5. Click "Publish release" |