Packaging and Releasing

Theory

We use semantic versioning.

Bug fixes not affecting the API increment the patch version, backwards compatible API additions/changes increment the minor version, and backwards incompatible API changes increment the major version.

Key points are these:

1. Version 1.0.0 defines the public API. The way in which the version number is incremented after this release is dependent on this public API and how it changes.
2. Patch version Z (x.y.Z) MUST be incremented if only backwards compatible bug fixes are introduced. A bug fix is defined as an internal change that fixes incorrect behavior.
3. Minor version Y (x.Y.z) MUST be incremented if new, backwards compatible functionality is introduced to the public API. It MUST be incremented if any public API functionality is marked as deprecated. It MAY be incremented if substantial new functionality or improvements are introduced within the private code. It MAY include patch level changes. Patch version MUST be reset to 0 when minor version is incremented.
4. Major version X (X.y.z) MUST be incremented if any backwards incompatible changes are introduced to the public API. It MAY include minor and patch level changes. Patch and minor version MUST be reset to 0 when major version is incremented.

Prerequisites:

• [git] (http://code.google.com/p/msysgit/) is setup and in your Windows PATH
• ruby is installed and in your Windows PATH
• nokogiri, rubyzip, mustache, and aws-s3 gems are installed.
• MSBuild.exe (v3.5) is in your Windows PATH

Steps

1. Determine the new release tag (e.g. something like v1.0.2) by examining RELEASE_NOTES.md and NEXT_VERSION.md. In the following steps, we'll call it <TAGNAME>.

2. Move the items from NEXT_VERSION.md into RELEASE_NOTES.md. Make sure the items are cleared from NEXT_VERSION.md. Commit and push the two files.

3. Make sure you are on master and have the most recent revision:

    git checkout master
    git pull
   

4. Run this script. You'll need to get the Amazon S3 keys. (These are Connamara's S3 keys; DO NOT post them to this wiki or include them in any Git-repo file!)

    package_release.bat <TAGNAME> <S3_ACCESS_KEY> <S3_SECRET_KEY>
   

   This script will update the downloads page, create the tag, build, package, and upload QuickFIX/n to the web.

5. Push the tag:

    git push origin master <TAGNAME>
   

6. Finally, deploy the website.