Skip to content

Releasing Sirius

Tommy Barker edited this page Mar 3, 2014 · 12 revisions

####1. Make a Release Branch

Create a separate branch for the release, sirius uses semantic versioning:

git branch release-x.x.x
git checkout release-x.x.x

Only two files should change in a release commit, pom.xml and build.sbt. Also only the version number of the project should change in these files.

The first line of the commit message should be Release x.x.x. The next paragraph should contain the most important changes since the last release. The next section contains every commit since the last release, which should be the output from

git log --pretty --oneline

The list of commits should be organized into logical sections, for example

  • New Features
  • Bugfixes
  • Documentation/Project Maintenance

See 1bda7c9c for an example.

Once everything has been committed to your fork, send in a pull request for review.

####2. Tag and Release Tagging should be done directly in the GitHub interface. Once the pull request has been accepted, go to the sirius page and click Draft a new release. in the tag version text box, type the release number using the github versioning standard with a v prepending the symantic version (vx.x.x).

####3. Build and Deploy Scala Docs

####4. Deploy Scala Artifacts Just a placeholder until Sirius is open source

####5. Increment Version to Next Snapshot