From 4e9c6184c4c37ecac0e5621de1fb3f11be4b1766 Mon Sep 17 00:00:00 2001 From: Riccardo Pittau Date: Mon, 14 Dec 2020 13:07:45 +0100 Subject: [PATCH] Fix release guide and include intermediate branches Fix the command to submit new releases and adds command reference for the intermediate bugfix branches. Change-Id: I79a039a6effcf8bd13e5c3ab5a231d5b515c8297 --- doc/source/contributor/releasing.rst | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/doc/source/contributor/releasing.rst b/doc/source/contributor/releasing.rst index 44ec3616eb..5d2da977c5 100644 --- a/doc/source/contributor/releasing.rst +++ b/doc/source/contributor/releasing.rst @@ -191,19 +191,27 @@ following the next steps: minor (feature) or patch (bugfix). Note that in this case ``series`` is a code name (train, ussuri), not a - branch. + branch. That is also valid for the current development branch (master) that + takes the code name of the future stable release, for example if the future + stable release code name is wallaby, we need to use wallaby as ``series``. The ``--stable-branch argument`` is used only for branching in the end of a cycle, independent projects are not branched this way though. + The ``--intermediate-branch`` option is used to create an intermediate + bugfix branch following the + `new release model for ironic projects `_. + To propose the release, use the script to update the deliverable file, then commit the change, and propose it for review. - For example, to propose a minor release for ironic in the master branch use: + For example, to propose a minor release for ironic in the master branch + (current development branch), considering that the code name of the future + stable release is wallaby, use: .. code-block:: bash - tox -e venv -- new-release -v master ironic feature + tox -e venv -- new-release -v wallaby ironic feature Remember to use a meaningful topic, usually using the name of the deliverable, the new version and the branch, if applicable.