summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRiccardo Pittau <elfosardo@gmail.com>2020-07-23 16:14:41 +0200
committerRiccardo Pittau <elfosardo@gmail.com>2020-07-23 16:18:31 +0200
commit271d85e99844bd49862b8514e4345181ae151fab (patch)
treead1cb4f70eecf5d9c68d79729930c50ac676a817
parentfbc3c798a1c29494078d97f039d3de325bb15d70 (diff)
downloadironic-271d85e99844bd49862b8514e4345181ae151fab.tar.gz
Update how to release section
Based on latest changes [1] in the releases project that changed the behavior of list_unreleased_changes. [1] https://opendev.org/openstack/releases/commit/4912f7d5d0a60b09ea54a5e6835c00847455f2dd Change-Id: If5fd848bf3fddeb1ae66dc9aafa882588b83f41a
-rw-r--r--doc/source/contributor/releasing.rst15
1 files changed, 7 insertions, 8 deletions
diff --git a/doc/source/contributor/releasing.rst b/doc/source/contributor/releasing.rst
index 71a91a695..44ec3616e 100644
--- a/doc/source/contributor/releasing.rst
+++ b/doc/source/contributor/releasing.rst
@@ -159,24 +159,23 @@ following the next steps:
* The ``_independent`` directory contains yaml files for deliverables that
are not bound to (official) cycles (e.g. ironic-python-agent-builder).
-* To check the changes we're about to release we can use the script
- ``list_unreleased_changes.sh``, that can be found under the ``tools``
- directory, with this syntax:
+* To check the changes we're about to release we can use the tox environment
+ ``list-unreleased-changes``, with this syntax:
.. code-block:: bash
- list_unreleased_changes.sh <branch> <deliverable>
+ tox -e venv -- list-unreleased-changes <series> <deliverable>
- The ``branch`` argument is a branch, not a release series (i.e. master or
- stable/train, not ussuri or train).
+ The ``series`` argument is a release series (i.e. master or train,
+ not stable/ussuri or stable/train).
For example, assuming we're in the main directory of the releases repository,
- to check the changes in the train branch for ironic-python-agent
+ to check the changes in the ussuri series for ironic-python-agent
type:
.. code-block:: bash
- ./tools/list_unreleased_changes.sh stable/train openstack/ironic-python-agent
+ tox -e venv -- list-unreleased-changes ussuri openstack/ironic-python-agent
* To update the deliverable file for the new release, we use a scripted process
in the form of a tox environment called ``new-release``.