shadowfacts/fonttools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add more instructions to make a release

Browse Source
This commit is contained in:
Jany Belluz 2022-09-30 16:39:32 +01:00
parent 8d3e6d286d
commit a2e6d341df
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.rst
View File

@ -211,7 +211,8 @@ How to make a new release
1) Update ``NEWS.rst`` with all the changes since the last release. Write a 1) Update ``NEWS.rst`` with all the changes since the last release. Write a
changelog entry for each PR, with one or two short sentences summarizing it, changelog entry for each PR, with one or two short sentences summarizing it,
as well as links to the PR and relevant issues addressed by the PR. as well as links to the PR and relevant issues addressed by the PR. Do not
put a new title, the next command will do it for you.
2) Use semantic versioning to decide whether the new release will be a 'major', 2) Use semantic versioning to decide whether the new release will be a 'major',
'minor' or 'patch' release. It's usually one of the latter two, depending on 'minor' or 'patch' release. It's usually one of the latter two, depending on
whether new backward compatible APIs were added, or simply some bugs were fixed. whether new backward compatible APIs were added, or simply some bugs were fixed.
@ -226,7 +227,8 @@ How to make a new release
It also commits an additional version bump which opens the main branch for It also commits an additional version bump which opens the main branch for
the subsequent developmental cycle the subsequent developmental cycle
4) Push both the tag and commit to the upstream repository, by running the command 4) Push both the tag and commit to the upstream repository, by running the command
``git push --follow-tags``. ``git push --follow-tags``. Note: it may push other local tags as well, be
careful.
5) Let the CI build the wheel and source distribution packages and verify both 5) Let the CI build the wheel and source distribution packages and verify both
get uploaded to the Python Package Index (PyPI). get uploaded to the Python Package Index (PyPI).
6) [Optional] Go to fonttools `Github Releases <https://github.com/fonttools/fonttools/releases>`__ 6) [Optional] Go to fonttools `Github Releases <https://github.com/fonttools/fonttools/releases>`__