Making releases

Overview

Notes on making new releases of RnaChipIntegrator.

In Local Git Clone

• Make a new release-X.Y.Z branch based off devel (can be local)
• Update the change log with significant changes since the last release
• Update the version number in rnachipintegrator/__init__.py
• Commit these changes to the release-X.Y.Z branch
• Checkout devel, merge release-X.Y.Z changes and push to GitHub
• Checkout master, merge release-X.Y.Z changes and push to GitHub
• Delete the release-X.Y.Z branch
• Tag the head commit as the new version e.g. git tag -a -m "Version X.Y.Z" vX.Y.Z
• Push new tag to GitHub: git push --tags

On GitHub

• Make a release using the new vX.Y.Z tag (use the name RnaChipIntegrator-vX.Y.Z)

Push to PyPI

Pre-requisites:

• If not already registered: python setup.py register -r pypi
• If registered then remove the repository line in the [pypi] section of your ~/.pypirc file
• Check you're using Python 2.7.9+

Make a virtualenv for uploading:

virtualenv pypi-upload
. pypi-upload/bin/activate
pip install -U pip setuptools twine

(NB needs setuptools 27+ and twine 1.8.0+ for Python 2.)

Create distribution and upload to PyPI:

• Download RnaChipIntegrator-vX.Y.Z.tar.gz from GitHub and unpack
• In unpacked directory, build files for distribution (will be made in the dist directory): python setup.py sdist
• Push to PyPI: twine upload dist/*

See notes in https://github.com/fls-bioinformatics-core/RnaChipIntegrator/issues/20 for more details.