Skip to content

Commit fcc6841

Browse files
committed
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>
1 parent c4617ff commit fcc6841

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

docs/RELEASE.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
# Release process
22

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
44
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
66
* Test packaging, uploading to Test PyPI and installing from a virtual environment
77
* Remove existing dist build dirs
88
* Create source dist `python setup.py sdist`
99
* Create wheel (with 2 and 3 support) `python setup.py bdist_wheel --universal`
1010
* Sign the dists `gpg --detach-sign -a dist/tuf-vA.B.C.tar.gz`
1111
* Upload to test PyPI `twine upload --repository testpypi dist/*`
1212
* 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
1414
* Once the PR is merged, pull the updated `develop` branch locally
1515
* Create a signed tag matching the updated version number on the merge commit
1616
`git tag --sign vA.B.C -m "vA.B.C"`
1717
* 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
1920
* Create a package for the formal release
2021
* Remove existing dist build dirs
2122
* Create source dist `python setup.py sdist`

0 commit comments

Comments
 (0)