Elgato_dark/python-tuf
1
0
Fork 0
mirror of https://github.com/theupdateframework/python-tuf synced 2026-05-24 10:08:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
python-tuf/docs/RELEASE.md
Joshua Lock 0db58df8aa Update release docs 
* Strongly encourage the reader to use Python 3 for creating release
  artefacts
* Recommend cleaning the tuf directory before creating the release

Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-10-05 11:22:08 +01:00

2.2 KiB
Raw Blame History

Release process

  • Ensure you have a backup of all working files and then remove files not tracked by git git clean -xdf. NOTE: this will delete all files in the tuf tree that aren't tracked by git
  • Ensure docs/CHANGELOG.md contains a one-line summary of each notable change since the prior release
  • Update setup.py and tuf/__init__.py to the new version number vA.B.C
  • Test packaging, uploading to Test PyPI and installing from a virtual environment (ensure commands invoking python below are using Python 3)
    • Remove existing dist build dirs
    • Create source dist python3 setup.py sdist
    • Create wheel (with 2 and 3 support) python3 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 develop branch locally
  • Create a signed tag matching the updated version number on the merge commit git tag --sign vA.B.C -m "vA.B.C"
    • Push the tag to GitHub git push origin vA.B.C
  • Create a new release on GitHub, copying the CHANGELOG.md entries for the release
  • Create a package for the formal release (ensure commands invoking python below are using Python 3)
    • Remove existing dist build dirs
    • Create source dist python3 setup.py sdist
    • Create wheel (with 2 and 3 support) python3 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