Release Process

Edit version

livekit/__init__.py:

-__version__ = "0.2.0"
+__version__ = "0.3.0"

Update CHANGES.md

Add a new version header under [Unreleased] with today's date

## [Unreleased]

+ ## [0.3.0] - 2022-05-27

Add a reference to the version diff at the bottom of the file, and update the [UNRELEASED] reference to [new version]...HEAD

-[Unreleased]: https://github.com/tradablebits/livekit-server-sdk-python/compare/v0.2.4...HEAD
+[Unreleased]: https://github.com/tradablebits/livekit-server-sdk-python/compare/v0.3.0...HEAD
+
+[0.3.0]: https://github.com/tradablebits/livekit-server-sdk-python/compare/v0.2.4...v0.3.0

Commit and tag the release:

git commit -am 'Release v0.3.0'
git tag -a v0.3.0 -m 'v0.3.0'
git push --atomic origin main v0.3.0

Build

$ python -m build

Upload to TestPyPi

$ twine upload -r testpypi dist/livekit_server_sdk_python-0.3.0*

Install the package in a different environment from testpypi and make sure it works. It may take a few minutes for the package index to update.

$ python3 -m venv env
$ source env/bin/activate
# replace [new version] with the actual version:
$ pip install -i https://test.pypi.org/simple/ 'livekit-server-sdk-python==[new version]'

Upload to PyPi

$ twine upload dist/livekit_server_sdk_python-0.3.0*

Create the release on GitHub

Using GitHub CLI:

$ gh release create v0.3.0 --generate-notes dist/livekit_server_sdk_python-0.3.0*

This creates the release from the tag and uploads the build files in one command.