Releases

When the changelog for a release gets sufficiently long or major features or fixes are implemented, we will tag and upload a release to PyPI.

Steps to prepare an ICEkit release:

  1. Merge all features to be included and ensure that tests pass and code operates as it should.

  2. Ensure documentation and changelog is up to date. In particular, edit the changelog so that major features appear first and are written such that users understand the benefits.

  3. In git, tag the release with the version number.

  4. Activate the pypi virtualenv and login to devpi using the password:

    workon devpi && devpi login ic --password={{ secret }}
    

    (see below for setting up the devpi virtualenv.)

  5. Upload a develop version of the package:

    python setup.py --version && devpi upload
    

    or release an official version on Pypi:

    devpi push django-icekit==<version> pypi:ixc
    

Private Package Index

We have a private, caching, on-demand mirror of PyPI (running devpi) that we can use to publish private packages.

It is available over HTTPS with basic authentication, plus a few whitelisted IP addresses for convenient access.

To install devpi:

mkvirtualenv devpi
pip install devpi-client django

Version numbers

We use setuptools_scm to get the version number directly from the version control system, which makes versioning part of the release process instead of being part of the development process.

and outdated at the next commit. Yay!

You can preview what the version number will be, before you build and upload:

python setup.py --version

The version number will be one of:

{tag}                                # no distance and clean
{tag}+d{YYYYMMDD}                    # no distance and not clean
{tag}.post{N}+n{commit}              # distance and clean
{tag}.post{N}+n{commit}.d{YYYYMMDD}  # distance and not clean

We use semantic versioning ({major}.{minor}.{patch}) when tagging releases.

For patch-level changes, you can forget about adding a tag and just use the generated version number. When uploading to a public index (PyPI), you must tag the release because public indexes may not accept packages with local version identifiers.