|
| 1 | +# Release process |
| 2 | + |
| 3 | +* Ensure docs/CHANGELOG.md contains a one-line summary of each significant |
| 4 | + change since the prior release |
| 5 | +* Update setup.py and `tuf/__init__.py` to the new version number vA.B.C |
| 6 | +* Test packaging, uploading to Test PyPI and installing from a virtual environment |
| 7 | + * Remove existing dist build dirs |
| 8 | + * Create source dist `python setup.py sdist` |
| 9 | + * Create wheel (with 2 and 3 support) `python setup.py bdist_wheel --universal` |
| 10 | + * Sign the dists `gpg --detach-sign -a dist/tuf-vA.B.C.tar.gz` |
| 11 | + * Upload to test PyPI `twine upload --repository testpypi dist/*` |
| 12 | + * Verify the uploaded package https://testpypi.python.org/pypi/tuf/ |
| 13 | +* Create a PR with updated CHANGELOG.md and version bumps |
| 14 | +* Once the PR is merged, pull the updated `develop` branch locally |
| 15 | +* Create a signed tag matching the updated version number on the merge commit |
| 16 | + `git tag --sign vA.B.C` |
| 17 | +* Create a new release on GitHub, copying the CHANGELOG.md entries for the release |
| 18 | +* Create a package for the formal release |
| 19 | + * Remove existing dist build dirs |
| 20 | + * Create source dist `python setup.py sdist` |
| 21 | + * Create wheel (with 2 and 3 support) `python setup.py bdist_wheel --universal` |
| 22 | + * Sign source dist `gpg --detach-sign -a dist/tuf-vA.B.C.tar.gz` |
| 23 | + * Sign wheel `gpg --detach-sign -a dist/tuf-vA.B.C-py2.py3-none-any.whl` |
| 24 | + * Upload to test PyPI `twine upload --repository testpypi dist/*` |
| 25 | + * Verify the uploaded package https://testpypi.python.org/pypi/tuf/ |
| 26 | + * Upload to PyPI `twine upload dist/*` |
| 27 | +* Attach the signed dists to the release on GitHub |
| 28 | +* Announce the release on [#tuf on CNCF Slack](https://cloud-native.slack.com/archives/C8NMD3QJ3) |
| 29 | +* Ensure [POUF 1](https://github.com/theupdateframework/taps/blob/master/POUFs/reference-POUF/pouf1.md), for the reference implementation, is up-to-date |
0 commit comments