Skip to content

MAINTAINING.md

Latest commit

 

History

History
16 lines (12 loc) · 1.4 KB

MAINTAINING.md

File metadata and controls

16 lines (12 loc) · 1.4 KB

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 version number - this is now done with a git tag (previously required editing __init__.py), e.g. git tag v0.1.14, then pushing, should now mean the build process reads that tag as the version number
  3. 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 is used for the heading and the (future) PyPI URL
  4. Commit release preparation - once you are happy with the steps above, commit with a message like 'Prepare release 0.1.14'
  5. Push branch - making sure github is up to date, (in future: CI)
  6. Clear out build and dist directories: OPTIONAL, but nice to start with a clean Python build environment before making this new version
  7. Run local build - python -m build should build dist and egg-into directories with the correct version number included
  8. Publish to PyPI - e.g. with twine, twine upload dist/*