Creating Releases

Releasing the toolbox

To push a new release to PyPI:

Before you start

1. Select the version number for the release (based on Semantic Versioning), in the format '1.2.3'
2. Make sure the develop branch is up to date with the code you would like to release and the tests are passing
3. Make sure the develop branch of the unittest data repository is up to date

Releasing

1. In the nPYc-toobox repository:
   1. Merge the develop branch in to master
   2. In the master branch, update the version numbers in README.md and setup.py
   3. Tag this commit, naming the tag in the form 'v1.2.3', add a descriptive summary of the release in the tag body
2. Follow the same procedure with the unittest data:
   1. Merge the develop branch in to master
   2. Tag this commit, making sure to tag with the same name used in the nPc-toolbox repository
3. Push the merge and tags in in the unittest repository back to GitHub
4. Push the merge and tags in in the nPYc-toolbox repository back to GitHub

Travis will then detect a tagged release on the master branch, package the release and push it up to PyPI.

Finishing up

1. In the develop branch, bump the version number in README.md and setup.py to the next minor version