Skip to content

RELEASING.md

Latest commit

 

History

History
33 lines (27 loc) · 832 Bytes

RELEASING.md

File metadata and controls

33 lines (27 loc) · 832 Bytes

Release Process

Preliminary

  • Check for breaking API changes.
sphinx-build -b text ./bugwarrior/docs new-docs-build ./bugwarrior/docs/other-services/api.rst
git checkout $LATEST_RELEASE
sphinx-build -b text ./bugwarrior/docs prev-docs-build ./bugwarrior/docs/other-services/api.rst
diff ./prev-docs-build/other-services/api.txt ./new-docs-build/other-services/api.txt
  • Update CHANGELOG.rst.
  • Update version in pyproject.toml.

Release

  • Git tag.
git tag X.Y.Z
git push upstream tag X.Y.Z
  • Publish to Pypi.
python -m build
twine upload dist/*
# These files can confuse development environment.
rm -rf dist/
  • Navigate to the tag in the GitHub releases UI and create a release, probably just copying from the CHANGELOG.

Postliminary

  • Update version in pyproject.toml to X.Y.Z.post.