This is documentation is mainly intended for core developers of TARDIS. There are several steps to do a release.

Update the Changelog

The changelog is located in CHANGELOG.rst in the root directory of TARDIS and contains a description of changes between versions. One useful idea is to mention all the pull requests, which can be accomplished with the tool github-changes and invoke it with

github-changes -o tardis-sn -r tardis --only-pulls --use-commit-body -f

which will write the pull requests into This can be used to put into the actual CHANGELOG.rst.

Doing the actual release

This is best done in a clean environment (so a fresh checkout from the master). We again use the astropy instructions: