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

35 lines
2 KiB
Markdown
Raw Normal View History

Document release process steps Write down the expected steps for a maintainer to follow when making a release of tuf Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-07-30 21:19:56 +00:00
# Release process
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 09:01:36 +00:00
* 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
More consistent formatting in RELEASE.md Consistently enclose filenames referred to througout the release process in backticks to ensure they are rendered in the code style. Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-09-09 10:07:23 +00:00
* Ensure `docs/CHANGELOG.md` contains a one-line summary of each [notable
docs/RELEASE.md: link to guidance on changelogs https://keepachangelog.com provides good advice on curating a changelog Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-08-04 08:49:08 +00:00
change](https://keepachangelog.com/) since the prior release
Remove references to setup.py We now use a static setup.cfg instead, update __init__.py and docs/RELEASE.md to point there. Signed-off-by: Joshua Lock <jlock@vmware.com>
2021-10-21 09:53:35 +00:00
* Update `setup.cfg` and `tuf/__init__.py` to the new version number vA.B.C
Document release process steps Write down the expected steps for a maintainer to follow when making a release of tuf Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-07-30 21:19:56 +00:00
* Test packaging, uploading to Test PyPI and installing from a virtual environment
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 09:01:36 +00:00
(ensure commands invoking `python` below are using Python 3)
Document release process steps Write down the expected steps for a maintainer to follow when making a release of tuf Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-07-30 21:19:56 +00:00
* Remove existing dist build dirs
docs/RELEASE: use build for building dists This is the PyPA recommend tool for building Python packages: https://packaging.python.org/guides/distributing-packages-using-setuptools/ Furthermore, direct invocation of setup.py is long ago deprecated: https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html Signed-off-by: Joshua Lock <jlock@vmware.com>
2021-10-19 20:06:15 +00:00
* Create source dist and wheel `python3 -m build`
Document release process steps Write down the expected steps for a maintainer to follow when making a release of tuf Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-07-30 21:19:56 +00:00
* 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/
More consistent formatting in RELEASE.md Consistently enclose filenames referred to througout the release process in backticks to ensure they are rendered in the code style. Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-09-09 10:07:23 +00:00
* Create a PR with updated `CHANGELOG.md` and version bumps
Document release process steps Write down the expected steps for a maintainer to follow when making a release of tuf Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-07-30 21:19:56 +00:00
* Once the PR is merged, pull the updated `develop` branch locally
* Create a signed tag matching the updated version number on the merge commit
Add tag pushing to RELEASE.md Ensure someone following the release process pushes the tag they create and include a tag message matching the common form, rather than requiring somebody following the steps to figure out what to enter into their editor Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-08-04 14:11:18 +00:00
`git tag --sign vA.B.C -m "vA.B.C"`
* Push the tag to GitHub `git push origin vA.B.C`
More consistent formatting in RELEASE.md Consistently enclose filenames referred to througout the release process in backticks to ensure they are rendered in the code style. Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-09-09 10:07:23 +00:00
* Create a new release on GitHub, copying the `CHANGELOG.md` entries for the
release
Document release process steps Write down the expected steps for a maintainer to follow when making a release of tuf Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-07-30 21:19:56 +00:00
* Create a package for the formal release
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 09:01:36 +00:00
(ensure commands invoking `python` below are using Python 3)
Document release process steps Write down the expected steps for a maintainer to follow when making a release of tuf Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-07-30 21:19:56 +00:00
* Remove existing dist build dirs
docs/RELEASE: use build for building dists This is the PyPA recommend tool for building Python packages: https://packaging.python.org/guides/distributing-packages-using-setuptools/ Furthermore, direct invocation of setup.py is long ago deprecated: https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html Signed-off-by: Joshua Lock <jlock@vmware.com>
2021-10-19 20:06:15 +00:00
* Create source dist and wheel `python3 -m build`
Document release process steps Write down the expected steps for a maintainer to follow when making a release of tuf Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-07-30 21:19:56 +00:00
* Sign source dist `gpg --detach-sign -a dist/tuf-vA.B.C.tar.gz`
Update release docs not to mention Python 2 Signed-off-by: Joshua Lock <jlock@vmware.com>
2021-09-06 12:29:51 +00:00
* Sign wheel `gpg --detach-sign -a dist/tuf-vA.B.C-py3-none-any.whl`
Document release process steps Write down the expected steps for a maintainer to follow when making a release of tuf Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-07-30 21:19:56 +00:00
* 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/*`
docs/RELEASE: use build for building dists This is the PyPA recommend tool for building Python packages: https://packaging.python.org/guides/distributing-packages-using-setuptools/ Furthermore, direct invocation of setup.py is long ago deprecated: https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html Signed-off-by: Joshua Lock <jlock@vmware.com>
2021-10-19 20:06:15 +00:00
* Attach both signed dists and their detached signatures to the release on GitHub
Document release process steps Write down the expected steps for a maintainer to follow when making a release of tuf Signed-off-by: Joshua Lock <jlock@vmware.com>
2020-07-30 21:19:56 +00:00
* Announce the release on [#tuf on CNCF Slack](https://cloud-native.slack.com/archives/C8NMD3QJ3)
* Ensure [POUF 1](https://github.com/theupdateframework/taps/blob/master/POUFs/reference-POUF/pouf1.md), for the reference implementation, is up-to-date
Reference in a new issue Copy permalink