Skip to content

Latest commit

 

History

History
51 lines (41 loc) · 1.15 KB

RELEASING.md

File metadata and controls

51 lines (41 loc) · 1.15 KB

Release process

  1. Export the necessary environment variables:
# Examples: '0.8.0', '0.8.0rc1', '0.8.0b1'
export VERSION={VERSION BEING RELEASED}

# See `gpg -k`
export GPG={YOUR GPG}
  1. Update version numbers to match the version being released:
vim -p src/result/__init__.py CHANGELOG.md
  1. Update diff link in CHANGELOG.md (see example):
vim CHANGELOG.md
  1. Do a signed commit and signed tag of the release:
git add src/result/__init__.py CHANGELOG.md
git commit -S${GPG} -m "Release v${VERSION}"
git tag -u ${GPG} -m "Release v${VERSION}" v${VERSION}
  1. Build source and binary distributions:
rm -rf ./dist
python3 -m build
  1. Upload package to PyPI:
twine upload dist/result-${VERSION}*
git push
git push --tags
  1. Optionally check the new version is published correctly
  1. Update version number to next dev version (for example after v0.9.0 this should be set to 0.10.0.dev0:
vim -p src/result/__init__.py