Skip to content

Commit

Permalink
add release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
pvdbosch committed Feb 25, 2022
1 parent 127a718 commit d0047cb
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Releasing

Each push to GitHub triggers a new GitHub Actions build using the maven-ci workflow.

To release, simply create a tag:

```
git tag -a v1.0.0 -m "release v1.0.0"
git push origin v1.0.0
```

This triggers a new GitHub Actions build (maven-release workflow) using the tag as version number and creates a draft release with the release artifact attached.
On the releases GitHub page, you can edit the release notes, set the pre-release checkbox if applicable, and publish the release.

If the build fails because the staging repository is down, you can restart the build by re-tagging it:

```
git tag -d v1.0.0
git push --delete origin v1.0.0
git tag -a v1.0.0 -m "release v1.0.0"
git push origin v1.0.0
```

0 comments on commit d0047cb

Please sign in to comment.