Skip to content

Release process

Janis Klaise edited this page May 3, 2019 · 26 revisions
  1. Bump the version in alibi/version.py to the release version (e.g. 0.1.1dev to 0.1.1)

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

    git commit -m 'v0.1.1'

  3. Add a tag

    git tag v0.1.1

  4. Push the change and the tag

    git push git push origin v0.1.1

  5. Generate CHANGELOG.md with github_changelog_generator

    github_changelog_generator -t your-github-token SeldonIO/alibi

  6. Commit the CHANGELOG.md to master and push

  7. On Github a release will be automatically published when you pushed the tag, delete this and create a new tag so that the CHANGELOG.md is included in this release. When creating the release, copy the changes relevant to this release from CHANGELOG.md

  8. Build the python package

    make build_pypi

  9. Publish the package on test PyPI to check everything is working fine

    make push_pypi_test

  10. 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

  11. If everything works, publish to real PyPI

    make push_pypi

Clone this wiki locally