From 739925a69fb0f1b0588c78f217b4023f4a00152c Mon Sep 17 00:00:00 2001 From: Tom Patzig Date: Thu, 26 May 2016 17:46:21 +0200 Subject: [PATCH] Adding info to use venv of tox for reno The tool reno is used to generate yaml releasenotes files. This patch adds doc info, how to use venv of tox to use reno, if reno is not installed globally on your system. TrivialFix Change-Id: Id1d2e8969db60f78eb6b4aebdff3329c5b35bc5b --- doc/source/devref/adding_release_notes.rst | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/doc/source/devref/adding_release_notes.rst b/doc/source/devref/adding_release_notes.rst index 526405594c..c60a7220ed 100644 --- a/doc/source/devref/adding_release_notes.rst +++ b/doc/source/devref/adding_release_notes.rst @@ -55,11 +55,26 @@ How do I add a release note? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ We use `Reno `_ to create and manage -release notes. To create a release note for your change, use: +release notes. The new subcommand combines a random suffix with a “slug” value +to make the new file with a unique name that is easy to identify again later. +To create a release note for your change, use: .. code-block:: console - $ reno new my_fancy_new_change + $ reno new slug-goes-here + +If reno is not installed globally on your system, you can use it from venv +of your manila's tox. Prior to running the above command, run: + +.. code-block:: console + + $ source .tox/py27/bin/activate + +Or directly as a one-liner, with: + +.. code-block:: console + + $ tox -e venv -- reno new slug-goes-here Then add the notes in ``yaml`` format in the file created. Pay attention to the type of section. The following are general sections to use: