Release process
Bump the package version and build documentation
Run the following command:
This will bump the version number in pyproject.toml and singlestoredb/__init__.py using semantic versioning rules: minor bump for new features, patch bump for bug fixes. It will genarete a list of changes since the last version and ask for confirmation of the release notes in docs/src/whatsnew.rst. It will then run make html in docs/src to generate documentation. You will need sphinx and sphinx_rtd_theme installed for this step. The documentation contains source which runs against a live server that is created using Docker.
Commit and push the changes
After verifying the release summary in the documentation, commit the changes. All modified files should be staged by bump_version.py already.
Final testing
The coverage tests will be triggered by the push, but it will likely only be a subset since Management API tests only get executed if the Management API source files are changed. You should run the full set of Coverage tests at and then run the Smoke tests which verify the code works at all of the advertised Python versions: Smoke test.
Create the release on Github
To create the release, run:
This will generate a tag and start the release process in the Publish packages Github workflow.