From a2e6d341df63178032547324fb9776c29160ca56 Mon Sep 17 00:00:00 2001 From: Jany Belluz Date: Fri, 30 Sep 2022 16:39:32 +0100 Subject: [PATCH] Add more instructions to make a release --- README.rst | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/README.rst b/README.rst index fdff24334..5f4b5c075 100644 --- a/README.rst +++ b/README.rst @@ -203,7 +203,7 @@ are required to unlock the extra features named "ufo", etc. Pen to drawing glyphs with FreeType as raster images, requires: - * `freetype-py `__: Python binding + * `freetype-py `__: Python binding for the FreeType library. How to make a new release @@ -211,7 +211,8 @@ How to make a new release 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, - 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', '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. @@ -226,7 +227,8 @@ How to make a new release It also commits an additional version bump which opens the main branch for the subsequent developmental cycle 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 get uploaded to the Python Package Index (PyPI). 6) [Optional] Go to fonttools `Github Releases `__ @@ -242,16 +244,16 @@ Acknowledgements In alphabetical order: aschmitz, Olivier Berten, Samyak Bhuta, Erik van Blokland, Petr van Blokland, -Jelle Bosma, Sascha Brawer, Tom Byrer, Antonio Cavedoni, Frédéric -Coiffier, Vincent Connare, David Corbett, Simon Cozens, Dave Crossland, -Simon Daniels, Peter Dekkers, Behdad Esfahbod, Behnam Esfahbod, Hannes -Famira, Sam Fishman, Matt Fontaine, Takaaki Fuji, Yannis Haralambous, Greg -Hitchcock, Jeremie Hornus, Khaled Hosny, John Hudson, Denis Moyogo Jacquerye, -Jack Jansen, Tom Kacvinsky, Jens Kutilek, Antoine Leca, Werner Lemberg, Tal +Jelle Bosma, Sascha Brawer, Tom Byrer, Antonio Cavedoni, Frédéric +Coiffier, Vincent Connare, David Corbett, Simon Cozens, Dave Crossland, +Simon Daniels, Peter Dekkers, Behdad Esfahbod, Behnam Esfahbod, Hannes +Famira, Sam Fishman, Matt Fontaine, Takaaki Fuji, Yannis Haralambous, Greg +Hitchcock, Jeremie Hornus, Khaled Hosny, John Hudson, Denis Moyogo Jacquerye, +Jack Jansen, Tom Kacvinsky, Jens Kutilek, Antoine Leca, Werner Lemberg, Tal Leming, Peter Lofting, Cosimo Lupo, Olli Meier, Masaya Nakamura, Dave Opstad, -Laurence Penney, Roozbeh Pournader, Garret Rieger, Read Roberts, Guido -van Rossum, Just van Rossum, Andreas Seidel, Georg Seifert, Chris -Simpkins, Miguel Sousa, Adam Twardoch, Adrien Tétar, Vitaly Volkov, +Laurence Penney, Roozbeh Pournader, Garret Rieger, Read Roberts, Guido +van Rossum, Just van Rossum, Andreas Seidel, Georg Seifert, Chris +Simpkins, Miguel Sousa, Adam Twardoch, Adrien Tétar, Vitaly Volkov, Paul Wise. Copyrights