From 61daa4519b8a5fffbd4f2ba8023f0af730ed77d9 Mon Sep 17 00:00:00 2001 From: Cosimo Lupo Date: Thu, 20 May 2021 17:49:35 +0100 Subject: [PATCH] mention release --minor, --major and --sign options --- README.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 645c18fb2..78f422ef2 100644 --- a/README.rst +++ b/README.rst @@ -215,8 +215,13 @@ How to make a new release '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. 3) Run ``python setup.py release`` command from the tip of the ``main`` branch. + By default this bumps the third or 'patch' digit only, unless you pass ``--major`` + or ``--minor`` to bump respectively the first or second digit. This bumps the package version string, extracts the changes since the latest - version from ``NEWS.rst``, and uses that text to create an annotated git tag. + version from ``NEWS.rst``, and uses that text to create an annotated git tag + (or a signed git tag if you pass the ``--sign`` option and your git and Github + account are configured for `signing commits `__ + using a GPG key). 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