Skip to content

Releasing

Jump to bottom
Ilya Flyamer edited this page Apr 15, 2021 · 2 revisions

Release checklist

  1. Check .github/workflows, .travis.yml, requirements.txt and setup.py and see if anything needs updating.

  2. Run the full test suite one final time!

pytest
  1. Build the docs locally and inspect the output.
cd docs && make html

  1. Complete the release notes in CHANGELOG.md

  2. Bump the version number in _version.py

  3. Commit and push to master. Wait for CI to give it the all-clear.

git commit -m 'Release v0.x.y'
git push origin master

  1. Draft and issue a new release on Github. Copy the new release notes if you like. Name the release as you would label the tag v0.x.y. Releasing will tag the latest commit and will trigger the stable docs build and the PyPI publishing action.

  2. Make sure PyPI publishing worked. Be careful, you can't take it back!

  3. Fetch the tag you just made.

git fetch --tags

  1. Update the bioconda recipe here:

  2. Create a new directory named as the previous version and copy the latest meta.yaml there.

  3. Edit the meta.yaml in the top level of cooltools directory: update the version on top, ensure the dependencies are correct for the new release, ensure build number is set to 0, and update the sha256 sum using one from pypi (https://pypi.org/project/cooltools/ - Download files - View hashes).

  4. Make a PR to bioconda-recipes and hope the tests pass (takes a very long time to run). Fix any issues that come up and push to the same PR.

  5. When tests pass, add a comment to the PR with text @BiocondaBot please add label to request a merge from one of the maintainers. (Can ask Joachim Wolff on Slack to do it to speed it up)

  6. Once the PR is merged, you are done, and the new release should appear on bioconda in 1-2 hours.

Note on version numbering:

We follow a rough approximation of semantic versioning. Only major releases (0.X.0) include breaking changes. Minor releases (0.X.Y) are for bug fixes and backwards compatible new features, but if a sufficient number of new features have arrived we will issue a major release even if there are no compatibility breaks.

Clone this wiki locally