Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.73 KB

MAINTAINING.md

File metadata and controls

18 lines (13 loc) · 1.73 KB
Raw

Maintenance instructions

These notes are for maintenance of the Git / PyPI source and releases / versions, rather than the installed client libraries - if you are not a maintainer, you can skip this doc!

Release tasks

All the tasks we need to do, in order, when releasing a new version:

  1. Check the main branch! - we should have all the changes we want to include merged/picked and tested
  2. 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.
  3. Update publish.sh - this simple publish script performs the publish to PyPI and will need the new version number
  4. 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.py is used for the heading and the (future) PyPI URL
  5. Commit release preparation - once you are happy with the steps above, commit with a message like 'Prepare release 0.1.10'
  6. Push branch - making sure github is up to date, (in future: CI)
  7. Clear out build and dist directories: OPTIONAL, but nice to start with a clean Python build environment before making this new version
  8. Run publish script - this will run setup.py to build a new version then upload to PyPI with twine - you will need an API token and publish access in PyPI to do this.

TODO: If we just keep a version file around or base builds on a version number extracted from tag name, some of these steps can be more easily automated or derived instead of updated by hand, but for now it's all pretty simple.