RELEASING.adoc

Releasing A New Version

Update Files

1. Update the version property in gradle.properties. We follow Semantic Versioning 2.0.0, so increment accordingly

2. Update RELEASE_NOTES.md with what has changed. Assuming the commit messages have been written well, it will generally be the subject lines of the commits since the last release, but edit (including adding) as appropriate for a human to easily understand what has changed

Create A Clean Build

$ ./gradlew clean check integrationTestReport createPackage

Commit and Push

$ git add gradle.properties docs/RELEASE_NOTES.md
$ git commit -m v9.9.9   # "v" followed by the version number
$ git tag v9.9.9
$ git push origin HEAD:master
$ git push origin v9.9.9

Create a new GitHub release, selecting the just-uploaded tag from the list. There’s no need for a “Release title”, though copy & paste the latest version information from RELEASE_NOTES.md into the “Describe this release” box. If you want you can attach the built artifact to the GitHub release, but the “official” location is BinTray.

NOTE: If you are back-porting a release or the like, GitHub’s “release” feature is extremely simplistic and always labels most recently create "release" record as being the “Latest release”.

Upload to BinTray

$ ./gradlew bintrayUpload

If you have not yet set up your credentials, the task will tell you what to do.