9. Maintaining#

9.1. Versioning#

Version numbers are as follows: MAJOR.MINOR.MICRO. Additionally, development version append devN where N is the distance (in commits) to the last release.

This is done automatically by setuptools_scm.

This plugin reads the latest tagged version from git and automatically increments the MICRO segment and appends devN. This is considered a pre-release.

The CI scripts will publish every tag with the format v.X.Y.Z to PyPI as version “X.Y.Z”. Additionally, for every push to main, it will be published as pre-release to TestPyPI (for now).

9.2. Releasing a new version#

Once the milestone is reached (all issues closed), it is time to do a new release. Make sure you have towncrier installed before proceeding.

  1. Make sure you are in sync with the main branch.

git checkout main
git pull --rebase origin main

  1. Run the following to check changelog is properly generated:

towncrier build --draft

  1. Then, run:

towncrier

to generate the proper changelog that should be reflected in docs/whats_new.rst.

  1. Commit the chages, make a PR and merge via a merge commit.

  2. Make sure you are in sync with the main branch.

git checkout main
git pull --rebase origin main

  1. Create tag (replace X.Y.Z with the proper version) on the merged PR’s merge commit.

git tag -a vX.Y.Z -m "Release X.Y.Z"

  1. Check that the build system is creating the proper version

SETUPTOOLS_SCM_DEBUG=1 python -m build --source --binary --out-dir dist/ .

  1. Push the tag

git push origin --follow-tags

  1. Optional: bump the MAJOR or MINOR segment of next release (replace D.E.0 with the proper version).

git tag -a vD.E.0.dev -m "Set next release to D.E.0"
git push origin --follow-tags