Skip to content

Commit

Permalink
document how to release
Browse files Browse the repository at this point in the history
  • Loading branch information
yanns committed May 31, 2021
1 parent cf0411c commit 9d7774c
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions HOW TO RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Release process

How to create a new [release](../../releases).

## Releasing

The release process is automated thanks to:
- https://github.com/djspiewak/sbt-github-actions#integration-with-sbt-ci-release
- https://github.com/olafurpg/sbt-ci-release

To release, push a git tag:

```
git tag -a v0.1.0 -m "v0.1.0"
git push origin v0.1.0
```
Note that the tag version MUST start with `v`.

Wait for the [CI pipeline](../../actions) to release the new version. Publishing the artifacts on maven central can take time.

## Updating the release notes

Open the [releases](../../releases). A draft should already be prepared.

Edit the draft release to set the released version. Complete the release notes if necessary. And save it.

0 comments on commit 9d7774c

Please sign in to comment.