This page describes how to make a release of Whirr. It is based on a similar guide for Tapestry (thanks to the Tapestry team for sharing this!).

Preparation

Check out the latest trunk.

Bumping the Version Number

The version number in trunk ends in -SNAPSHOT, but we need to remove this for the release. For example, 0.1.0-SNAPSHOT needs to be changed to 0.1.0. Use the supplied Ruby script (modified from the one in Tapestry) to do this. For example:

support/update-versions 0.1.0

Building

Build the release. You should run all the unit and integration tests (which means you should have cloud credentials to run on a cloud provider):

mvn clean install -DargLine='-Dwhirr.test.provider=<cloud-provider> -Dwhirr.test.identity=<cloud-provider-user> -Dwhirr.test.credential=<cloud-provider-secret-key>'

Add The Next Release to JIRA

Add the next version number (e.g. 0.2.0 after 0.1.0) to JIRA using this link: https://issues.apache.org/jira/secure/project/ManageVersions.jspa?pid=12311110.

In JIRA, you should also Release the version you are releasing now.

Generate the Release Notes

JIRA has the ability to generate release notes automatically (this is why it is so important to keep the fix version number accurate).

https://issues.apache.org/jira/secure/ConfigureReleaseNote.jspa?projectId=12311110

Manually check this list for accuracy! I've repeatedly seen closed bugs that were not fixed (i.e., duplicate) marked with a fix version, so that they incorrectly show up in this list. Find those, edit them to remove the fix release (only actually fixed bugs should have a fix release) and re-run the report.

Select the correct version, in HTML format.

Paste the notes to the top of site/src/site/xdoc/release-notes.xml

Wrap the title ("Release Notes - Whirr - Version 0.1.0") inside an <h1> element.

Build and Deploy Artifacts

TODO: enable http://maven.apache.org/plugins/maven-gpg-plugin/

(Build CLI jar and src distribution:

mvn assembly:assembly -DdescriptorId=src

TODO: complete process