From 0db58df8aa8cead09b6275ccf86ade79e2801d28 Mon Sep 17 00:00:00 2001 From: Joshua Lock Date: Mon, 5 Oct 2020 10:01:36 +0100 Subject: [PATCH] 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 --- docs/RELEASE.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/RELEASE.md b/docs/RELEASE.md index 04439759..ec1ad2a1 100644 --- a/docs/RELEASE.md +++ b/docs/RELEASE.md @@ -1,12 +1,16 @@ # 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](https://keepachangelog.com/) 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 `python setup.py sdist` - * Create wheel (with 2 and 3 support) `python setup.py bdist_wheel --universal` + * 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/ @@ -18,9 +22,10 @@ * 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 `python setup.py sdist` - * Create wheel (with 2 and 3 support) `python setup.py bdist_wheel --universal` + * 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/*`