These notes are for maintenance of the Git / PyPI source and releases, rather than the client library - if you are not a maintainer, you can skip this doc!
All the tasks we need to do, in order, when releasing a new version:
-
- Check the main branch! - we should have all the changes we want to include merged/picked and tested
-
- Update setup.py - this might include other dependency or project description changes, but usually will just be a case of incrementing the version number, e.g.
0.1.9->0.1.10. Note the new number.
- Update setup.py - this might include other dependency or project description changes, but usually will just be a case of incrementing the version number, e.g.
-
- Update publish.sh - this simple publish script performs the publish to PyPI and will need the new version number
-
- Update CHANGELOG.md - new versions go at the top of the file. See previous release blocks for formatting. I include a 'thanks' or 'reported by' attribution for PRs contributed or issues reported. The new version number from
setup.pyis used for the heading and the (future) PyPI URL
- Update CHANGELOG.md - new versions go at the top of the file. See previous release blocks for formatting. I include a 'thanks' or 'reported by' attribution for PRs contributed or issues reported. The new version number from
-
- Commit release preparation - once you are happy with the steps above, commit with a message like 'Prepare release 0.1.10'
-
- Push branch - making sure github is up to date, (in future: CI)
-
- Clear out build and dist directories: OPTIONAL, but nice to start with a clean Python build environment before making this new version
-
- Run publish script - this will run
setup.pyto build a new version then upload to PyPI with twine - you will be prompted for credentials interactively
- Run publish script - this will run
TODO: If we just keep a version file around some of these steps can be more easily automated or derived instead of updated by hand, but for now it's all pretty simple.