Skip to content

Releasing

Jump to bottom
Will Warren edited this page May 12, 2021 · 4 revisions

This doc is for maintainers of ServerTap

Releasing a new version

Releasing is done using the maven-release-plugin. As such you need to have Maven (3.0.4+) installed on your machine and available using the command mvn. You can check using mvn -version.

Performing the release

The release process is captured in code in the release.sh script BUT you must have your SSH key in your SSH Agent (ssh-add ~/.ssh/yourkey_rsa).

Once your key is ready, and you want to release what is currently at the HEAD of master, you can simply do:

./release.sh

The release plugin will prompt for values for the Version number, but you can leave it all as-is.

The release plugin will automatically update the version in src/main/resources/plugin.yml during the release, so the commit that ends up being TAGGED contains the right version numbers etc. See https://github.com/phybros/servertap/commit/07e7ee763e9a72a9efed66072c2d8ba8846684cc for an example.

Automatically created commits

You will get 2 commits automatically pushed to Github under your name as part of this process: 1 will increment the version numbers to the release version (e.g. v0.0.3) and the second will then subsequently update them again to the Next version (e.g. v0.0.4-SNAPSHOT)

Automatically built JAR file

Github actions will build the release JAR for you. Just go to the Actions tab, and click on the build with your release TAG next to it. At the bottom of the Page will be a "Release" that you can download. This is a ZIP with the packaged JAR in it. This should be used in the Create Release page.

Clone this wiki locally