Releasing

Steps before a release

• Before making a release, you need to make a changelog with the changes. The changelog is in docs/changelog.md (see Versioned HDF5 Change Log).

• It’s a good idea to push up your changes as a GitHub PR before doing the final release cut so that the CI runs all the tests. You can merge the PR once the release is made.

• Make sure to update version pinning in setup.py if necessary, e.g., if the minimum supported version of h5py or ndindex has changed.

Doing the release

Versioned HDF5 uses rever for releases. To do a release, install rever then run

$ rever <VERSION>

where <VERSION> is the version number for the release, like rever 1.0.

This will automatically run all the steps in the rever.xsh file.

Note

If you see an error like json.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0) this is due to a bug in rever. Simply run the rever command again and it will pisk up where it left off.

You will need push access to GitHub to push the tag and push access to PyPI to push up the release tarball. If you have never done a release before, the script will ask you to authenticate.

Updating conda-forge

The bot will make a pull request to the conda-forge feedstock automatically. You will need to be listed as a maintainer in the recipe to be able to merge it. If you aren’t, make a PR adding yourself.