HOWTO Release

This is a Howto guide on the commands to run and files to update in order to publish a new release of the Python SDK to Pypi

Poetry will handle things for us. You need to configure poetry with your pypi token for the publishing process to work.

Enable testing publishing on pypi test index.

poetry config repositories.test-pypi https://test.pypi.org/legacy/
poetry config pypi-token.test-pypi pypi-XXXXX

To setup your token to publish to pypi.

poetry config pypi-token.pypi pypi-XXXXX`````

Update the changelog, the version file, and the test file as done in this commit and push it to main.
Update the version

# e.g: 0.2.2 -> 0.2.3a0
poetry version prerelease
# or the following for, e.g.: 0.2.3
poetry version patch

Pypi test index

poetry build
poetry publish -r test-pypi

To publish to pypi

poetry publish

Now that release has been published on Pypi, please head to GitHub to draft a new tag release. Point this tag release to the latest commit pushed on step 1 above. Once you're done drafting the release, go ahead to publish it.

If all the steps above have been followed without errors, then you've successfully published a release. 🎉

Provide feedback