Home

Notes on cutting a release

1. Create a release branch for each new major or minor release, i.e. 3.1_rel onto which all the 3.1.x releases will live. Unless otherwise noted all the rest of these commands will be on that branch.

2. In setup.py change default_version to be the tag of the release you are creating. i.e. 3.1.0

3. Similarly in docs/sources/conf.py changes version and release to the same tag.

4. Checking in those changes above.

5. Create the git tag for that release: 3.1.0rc0, 3.1.0, etc.

At this point a git describe --tags --dirty should show the release tag (3.1.0) and nothing else (not 3.1.0rc0-dirty, etc.)