Release HOWTO

Test

In the general case tests can be run via pytest:

$ pytest tests

When preparing a release it is important to check that hubugs works with all currently supported Python versions, and that the documentation is correct.

Prepare release

With the tests passing, perform the following steps

  • Update the version data in hubugs/_version.py

  • Update NEWS.rst, if there are any user visible changes

  • Commit the release notes and version changes

  • Create a signed tag for the release

  • Push the changes, including the new tag, to the GitHub repository

Update PyPI

Create and upload the new release tarballs to PyPI:

$ ./setup.py sdist --formats=bztar,gztar register upload --sign

Fetch the uploaded tarballs, and check for errors.

You should also perform test installations from PyPI, to check the experience hubugs users will have.