Preparing for a Release

• Ensure all tests pass as expected. There should already be a branch named after the release (e.g. v1.2.3) so merge all relevant branches onto it beforehand. To find out which branches require to be merged in, run the following:

  git branch -a --no-merged

  Pushing this branch back to GitHub will kick off the rspec tests. Check the results at:

  • https://travis-ci.org/locp/cassandra
  • https://coveralls.io/github/locp/cassandra

  Assuming that these complete successfully, complete the beaker tests against all supported operating systems. These tests take a long time to complete so they should be a final step in the testing process.

  for node in $( rake beaker_nodes ); do
    BEAKER_set=$node BEAKER_destroy=onpass rake beaker || break
  done

• Update the CHANGELOG.

• Edit the metadata with the new release number with one of the following:

  rake module:bump:major # Bump module version to the next MAJOR version
  rake module:bump:minor # Bump module version to the next MINOR version
  rake module:bump:patch # Bump module version to the next PATCH version

  The commit comment for the checking of metadata.json should simply be the version number (e.g. v1.2.3).

• Create a tag of the version number using:

  git tag 1.2.3
  git push --tags

• Run spec build and upload the package to the forge.

A suitable template for an issue to be raised to track the steps required to complete a release could be:

- [ ] A branch has been created for the release (e.g. v1.2.3)
- [ ] All branches have been merged onto the release branch.
- [ ] All spec tests are passing as expected.
- [ ] All beaker tests are passing as expected.
- [ ] The change log has been updated.
- [ ] The metadata has been updated.
- [ ] The package has been built and uploaded to Puppet Forge.
- [ ] The milestone associated with the release has been closed.
- [ ] All branches associated with issues closed down in the release have been deleted.
- [ ] The http://locp.github.io/cassandra page has been updated.
- [ ] A message has been posted to https://gitter.im/locp/cassandra