Skip to content

Commit bf511ec

Browse files
author
Jussi Kukkonen
committed
docs: Update release docs
* version number is single sourced now * Mention that using pip against test.pypi.org is unsafe * Fix some filenames in the examples Signed-off-by: Jussi Kukkonen <jkukkonen@vmware.com>
1 parent 5155ba7 commit bf511ec

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

docs/RELEASE.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,18 @@
55
tracked by git
66
* Ensure `docs/CHANGELOG.md` contains a one-line summary of each [notable
77
change](https://keepachangelog.com/) since the prior release
8-
* Update `setup.cfg` and `tuf/__init__.py` to the new version number vA.B.C
8+
* Update `tuf/__init__.py` to the new version number "A.B.C"
99
* Test packaging, uploading to Test PyPI and installing from a virtual environment
1010
(ensure commands invoking `python` below are using Python 3)
1111
* Remove existing dist build dirs
1212
* Create source dist and wheel `python3 -m build`
13-
* Sign the dists `gpg --detach-sign -a dist/tuf-vA.B.C.tar.gz`
13+
* Sign source dist `gpg --detach-sign -a dist/tuf-A.B.C.tar.gz`
14+
* Sign wheel `gpg --detach-sign -a dist/tuf-A.B.C-py3-none-any.whl`
1415
* Upload to test PyPI `twine upload --repository testpypi dist/*`
15-
* Verify the uploaded package https://testpypi.python.org/pypi/tuf/
16+
* Verify the uploaded package at https://test.pypi.org/project/tuf/:
17+
Note that installing packages with pip using test.pypi.org is potentially
18+
dangerous (as dependencies may be squatted): download the file and install
19+
the local file instead.
1620
* Create a PR with updated `CHANGELOG.md` and version bumps
1721
* Once the PR is merged, pull the updated `develop` branch locally
1822
* Create a signed tag matching the updated version number on the merge commit
@@ -24,11 +28,10 @@
2428
(ensure commands invoking `python` below are using Python 3)
2529
* Remove existing dist build dirs
2630
* Create source dist and wheel `python3 -m build`
27-
* Sign source dist `gpg --detach-sign -a dist/tuf-vA.B.C.tar.gz`
28-
* Sign wheel `gpg --detach-sign -a dist/tuf-vA.B.C-py3-none-any.whl`
29-
* Upload to test PyPI `twine upload --repository testpypi dist/*`
30-
* Verify the uploaded package https://testpypi.python.org/pypi/tuf/
31+
* Sign source dist `gpg --detach-sign -a dist/tuf-A.B.C.tar.gz`
32+
* Sign wheel `gpg --detach-sign -a dist/tuf-A.B.C-py3-none-any.whl`
3133
* Upload to PyPI `twine upload dist/*`
34+
* Verify the package at https://pypi.org/project/tuf/ and by installing with pip
3235
* Attach both signed dists and their detached signatures to the release on GitHub
3336
* Announce the release on [#tuf on CNCF Slack](https://cloud-native.slack.com/archives/C8NMD3QJ3)
3437
* 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

Comments
 (0)