From 162cacb46599710039ea62bb0bb9fa8c3a6c7c00 Mon Sep 17 00:00:00 2001 From: Cosimo Lupo Date: Fri, 31 May 2024 19:39:35 +0100 Subject: [PATCH] README: suggest to install dev-requirements.txt before release setup_requires is deprecated, and relying on it to bootstrap the readme_renderer sometimes fails, better to ensure it's already pip installed before running release command --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 2274fbdc6..b604ea7ca 100644 --- a/README.rst +++ b/README.rst @@ -232,7 +232,8 @@ How to make a new release 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. -3) Run ``python setup.py release`` command from the tip of the ``main`` branch. +3) From inside a venv, first do ``pip install -r dev-requirements.txt``, then run + the ``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