release-process.md

Cutting a new release of the Spin Python SDK

To cut a new release, you will need to do the following:

1. Confirm that CI is green for the commit selected to be tagged and released.

2. If not already bumped, set the intended release version in pyproject.toml, create a pull request with these changes and merge once approved.

3. Checkout the commit with the version bump from above.

4. Create and push a new tag with a v and then the version number.

   As an example, via the git CLI:

   # Create a GPG-signed and annotated tag
   git tag -s -m "Spin Python SDK v4.1.0" v4.1.0
   
   # Push the tag to the remote corresponding to spinframework/spin-python-sdk (here 'origin')
   git push origin v4.1.0
   

5. Pushing the tag upstream will trigger the release action which publishes the distribution to pypi.org

6. If applicable, create PR(s) or coordinate documentation needs, e.g. for new features or updated functionality.