Skip to content

Files

Latest commit

d6e27c3 · Feb 24, 2023

History

History
20 lines (14 loc) · 746 Bytes

DEVELOPMENT.md

File metadata and controls

20 lines (14 loc) · 746 Bytes

Development

Dependencies are managed with poetry: poetry install

Tests are run with ./runtests

Releasing

CI handles releasing to PyPI. Releases on GitHub are created automatically, using the message from the annotated tag.

Here's how to do a release:

  • Get all the desired changes into master
  • Wait for CI to pass that
  • Add a bump commit (see previous "Declare vX.Y.Z" commits; poetry version may be useful here)
  • Push that commit on master
  • Create a tag of that version number, with a description of the changes in the annotation (git tag v$(poetry version --short) --annotate)
  • Push the tag (git push --tags)
  • CI will build & deploy that release as a GitHub Release and to PyPI