ArviZ Release Checklist

This documents the recommended procedure for creating a new release of ArviZ. Each of the following steps should be executed in order:

1. Create branch for release, and check out this branch.

2. Ensure that the example notebooks in docs/source/notebooks run without error.

3. Increment the version number and update changelog sections (also make sure there are no repeated entries...).

   • This is currently located in arviz\__init__.py. Optional: increment versions of external dependencies in .azure-pipelines/azure-pipelines-external.yml

4. Install for local development (with new version number), and run tests:

   python setup.py develop
   pytest arviz/tests

5. Test that it installs with pip:

   • create test virtual environment (virtualenv)
   • activate virtualenv
   • install to virtualenv with pip arviz/
   • deactivate and delete virtualenv

6. Push branch to GitHub and confirm TravisCI test pass.

7. Merge into master.

8. Draft a new release using github https://github.com/arviz-devs/arviz/releases

9. Release on PyPI using Twine:

   python setup.py sdist bdist_wheel
   twine upload dist/*

   (note it might have to be twine upload dist/arviz0.3.* or similar if you have done this before) (note you may need to install twine with pip)

10. Install new version from PyPI and python -c 'from arviz import *'.

11. Announce the good news on twitter!

Other notes

• Zenodo should generate a DOI. The integration is currently active through @canyon289's Zenodo account