mirror of
https://github.com/theupdateframework/python-tuf
synced 2026-05-24 10:08:28 +00:00
https://keepachangelog.com provides good advice on curating a changelog Signed-off-by: Joshua Lock <jlock@vmware.com>
1.8 KiB
1.8 KiB
Release process
- Ensure docs/CHANGELOG.md contains a one-line summary of each notable change since the prior release
- Update setup.py and
tuf/__init__.pyto the new version number vA.B.C - Test packaging, uploading to Test PyPI and installing from a virtual environment
- Remove existing dist build dirs
- Create source dist
python setup.py sdist - Create wheel (with 2 and 3 support)
python setup.py bdist_wheel --universal - Sign the dists
gpg --detach-sign -a dist/tuf-vA.B.C.tar.gz - Upload to test PyPI
twine upload --repository testpypi dist/* - Verify the uploaded package https://testpypi.python.org/pypi/tuf/
- Create a PR with updated CHANGELOG.md and version bumps
- Once the PR is merged, pull the updated
developbranch locally - Create a signed tag matching the updated version number on the merge commit
git tag --sign vA.B.C - Create a new release on GitHub, copying the CHANGELOG.md entries for the release
- Create a package for the formal release
- Remove existing dist build dirs
- Create source dist
python setup.py sdist - Create wheel (with 2 and 3 support)
python setup.py bdist_wheel --universal - Sign source dist
gpg --detach-sign -a dist/tuf-vA.B.C.tar.gz - Sign wheel
gpg --detach-sign -a dist/tuf-vA.B.C-py2.py3-none-any.whl - Upload to test PyPI
twine upload --repository testpypi dist/* - Verify the uploaded package https://testpypi.python.org/pypi/tuf/
- Upload to PyPI
twine upload dist/*
- Attach the signed dists to the release on GitHub
- Announce the release on #tuf on CNCF Slack
- Ensure POUF 1, for the reference implementation, is up-to-date