Release process

0. cd somewhere and get a clean version of alibi:

   git clone [email protected]:SeldonIO/alibi.git

1. Bump the version in alibi/version.py to the release version (e.g. 0.1.1dev to 0.1.1)

2. Add any changes from the previous release to CHANGELOG.md, follow the style of Keep a changelog

3. Commit the change with a message e.g.

   git commit -m 'v0.1.1'

4. Add a tag

   git tag v0.1.1

5. Push the change and the tag

   git push

   git push origin v0.1.1

6. On Github a release will be automatically published when you pushed the tag, edit the release and copy the changes relevant to this release from CHANGELOG.md

7. Build the python package

   make build_pypi

8. Publish the package on test PyPI to check everything is working fine (run pip install twine if you don't have twine installed already)

   make push_pypi_test

9. Check that it can be intalled from the test PyPI

   pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple alibi

10. If everything works, publish to real PyPI

    make push_pypi

11. Bump the version in alibi/version.py to 0.1.2dev and push

12. Change readthedocs.org default page to the newest version, e.g. 0.1.1