Skip to content

Release#

The software release has four main goals:

  1. Merge the new features to the production branch
  2. Create a GitHub Release
  3. Update the documentation
  4. Publish a new version of the package at PyPI

The 📝 RELEASE_PROCEDURE.md contain detailed instructions to do a release.

Automated Versioning with Bumpversion#

Bumpversion is a tool for automated version management in software projects.
It ensures consistent version updates across files and documentation
by specifying a part to increment (major, minor, or patch).
This streamlines release workflows and keeps project versioning synchronized.

Install package:
💻 pip install --upgrade bump-my-version
📝 .bumpversion.toml Configuration file for versioning rules and affected files

Test bumpversion:
💻 bump-my-version show-bump Preview next possible versions
💻 bump-my-version bump minor --dry-run -vv Sandbox bump

Use bumpversion:
💻 bump-my-version bump --current-version 0.2.0 minor
Run bumpversion 💠 git push Push bumpversion changes

Used Icons

🐙 GitHub | 💠 git | 📝 File | 💻 Command Line