|
1 | 1 | # Release process |
2 | 2 |
|
3 | | -* Ensure docs/CHANGELOG.md contains a one-line summary of each [notable |
| 3 | +* Ensure `docs/CHANGELOG.md` contains a one-line summary of each [notable |
4 | 4 | change](https://keepachangelog.com/) since the prior release |
5 | | -* Update setup.py and `tuf/__init__.py` to the new version number vA.B.C |
| 5 | +* Update `setup.py` and `tuf/__init__.py` to the new version number vA.B.C |
6 | 6 | * Test packaging, uploading to Test PyPI and installing from a virtual environment |
7 | 7 | * Remove existing dist build dirs |
8 | 8 | * Create source dist `python setup.py sdist` |
9 | 9 | * Create wheel (with 2 and 3 support) `python setup.py bdist_wheel --universal` |
10 | 10 | * Sign the dists `gpg --detach-sign -a dist/tuf-vA.B.C.tar.gz` |
11 | 11 | * Upload to test PyPI `twine upload --repository testpypi dist/*` |
12 | 12 | * Verify the uploaded package https://testpypi.python.org/pypi/tuf/ |
13 | | -* Create a PR with updated CHANGELOG.md and version bumps |
| 13 | +* Create a PR with updated `CHANGELOG.md` and version bumps |
14 | 14 | * Once the PR is merged, pull the updated `develop` branch locally |
15 | 15 | * Create a signed tag matching the updated version number on the merge commit |
16 | 16 | `git tag --sign vA.B.C -m "vA.B.C"` |
17 | 17 | * Push the tag to GitHub `git push origin vA.B.C` |
18 | | -* Create a new release on GitHub, copying the CHANGELOG.md entries for the release |
| 18 | +* Create a new release on GitHub, copying the `CHANGELOG.md` entries for the |
| 19 | + release |
19 | 20 | * Create a package for the formal release |
20 | 21 | * Remove existing dist build dirs |
21 | 22 | * Create source dist `python setup.py sdist` |
|
0 commit comments