Maintaining Bionic

This page documents project maintenance processes followed by Bionic’s core developers. If you’re not a core developer but need a new release for some reason, please contact one of the developers listed here.

Release Process

We use bumpversion to manage our version strings and GitHub Releases to publish releases to PyPI. Follow these steps to release a new version of Bionic:

  1. Merge a PR with updates to our version strings and release notes.

    1. Check out the current master branch.

    2. Create a new branch.

    3. Run bumpversion minor or bumpversion patch to bump the version. Running this command will create a new commit with all the version strings updated to the new version.

    4. Follow the commented instructions near Upcoming Version in the release-notes.rst file and update the upcoming version section.

    5. Amend the commit to add the release notes changes.

    6. Open a PR for your branch and merge it after approval from another core developer.

  2. Once your PR is merged, create a release from the GitHub Releases page.

    1. On the GitHub Releases page, click Draft a new release.

    2. Specify the bumped version as the Tag version and Release title. Don’t forget to prefix the version with v. E.g., if the new version is 0.8.0, your tag and title should both be v0.8.0.

    3. Click Publish Release.

    4. Verify that the Upload Python Package Action workflow was completed successfully and the new release is visible on PyPI.