Skip to content

Latest commit

 

History

History
17 lines (10 loc) · 1.58 KB

RELEASING.md

File metadata and controls

17 lines (10 loc) · 1.58 KB

Releasing Cohorts

This document explains what do once your Pull Request has been reviewed and all final changes applied. Now you're ready merge your branch into master and release it to the world:

  1. Assign a version to the release you are preparing. cohorts uses versioneer, so rather than explicitly editing a __version__ variable in the code you must instead tag the branch with your new version number (e.g. git tag 1.2.3).

  2. Once your candidate release branch is tagged you must then run git push --tags and merge the branch.

  3. After the cohorts unit tests complete successfully on Travis then the latest version of the code (with the version specified above) will be pushed to PyPI automatically. If you're curious about how automatic deployment is achieved, see our Travis configuration.

  4. Finally, from a clean copy of the master branch, run github-changelog-generator from the cohorts directory (first, install it if needed). Then commit/push master to GitHub.

You're done!

General note about versioneer: whether you should do git tag v1.2.3 vs. git tag 1.2.3 depends on versioneer settings, which can be found in setup.cfg and _version.py (because _version.py was generated from setup.cfg configuration, the two should match.) In cohorts, git tag 1.2.3 (without the v) is what's expected.