Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 842 Bytes

RELEASING.rst

File metadata and controls

40 lines (23 loc) · 842 Bytes

Releasing

These are the steps to create a release

  1. Create Release branch:

    $ git checkout -b 0.7.x-release master
  2. Bump version number:

    $ poetry version 0.7.x
  3. Create a draft release in GitHub

    Generate the release notes in GitHub Add to the top of the CHANGELOG.rst file (TODO automate this step into the docs build)

  4. Test the build:

    $ poetry build

    Check the dist directory sources are as expected

  5. Commit changes and merge to master:

    $ git commit -m "Bump version to 0.7.x"

    Create and merge PR into master

  6. Publish the release on GitHub

    GitHub workflow pythonpublish.yml will then publish to pypi.org readthedocs will compile the latest docs

  7. Check the release

    Verify on pypi and readthedocs.io