Creating TxBR Release

This page describes deployment process for TxBR

NOTE: THESE INSTRUCTIONS ARE FOR DOING A RELEASE ONLY AND NOT FOR REGULAR COMMITS

NOTE: Releases should be done from master branch.

Testing

Updating version

Before doing a release, the code must be assigned a new version, committed to github.

To update version run make updateversion as seen below and increment the version. For test releases append rc# such as rc1 to version to denote its a release candidate. This Makefile target simply updates the VERSION file.

$ make updateversion
Current (3.1.4) enter new version: 3.1.5rc1
Updating VERSION with new version: 3.1.5rc1

Commit and push the changed VERSION file

git commit -m 'updated to version 3.1.5rc1' VERSION
git push origin <branch name or master>

Update HISTORY.rst with changes

Update the HISTORY.rst file with changes in version. Be sure to commit and push these changes to github.

Create distribution

Run make dist which creates a distribution locally that can be examined by looking in dist/ directory

make dist

Output:

rm -fr build/
rm -fr dist/
rm -fr .eggs/
find . -name '*.egg-info' -exec rm -fr {} +
find . -name '*.egg' -exec rm -fr {} +
find . -name '*.pyc' -exec rm -f {} +
find . -name '*.pyo' -exec rm -f {} +
find . -name '*~' -exec rm -f {} +
find . -name '__pycache__' -exec rm -fr {} +
rm -fr .tox/
rm -f .coverage
rm -fr htmlcov/
cp: cannot copy a directory, 'dist', into itself, 'dist/txbr-3.1.5rc1/./dist'
total 16116
drwxrwxr-x 10 foo foo     4096 Jul 16 13:33 txbr-3.1.5rc1
-rw-rw-r--  1 foo foo    12419 Jul 16 13:33 txbr_3.1.5rc1_basic_cloudformation.json
-rw-rw-r--  1 foo foo 16481706 Jul 16 13:33 txbr-3.1.5rc1.tar.gz

Create release

WARNING: To run a release one must be able to commit, tag, and push. In addition, write access to S3 bucket is needed.

make release

Document release on github

1. From https://github.com/nbcrrolls/txbr-source click on releases link.
2. Click on the Draft a new release button.
3. In the Tag version field select the version set above.
4. Enter a release title and describe changes in release copying notes put into HISTORY.rst.
5. Attach source tree and cloudformation template created above to release via the Attach binaries link on the page.
6. Click publish release.