summaryrefslogtreecommitdiff
path: root/doc/source/developing.rst
diff options
context:
space:
mode:
authorDean Troyer <dtroyer@gmail.com>2015-12-02 10:04:39 -0600
committerDean Troyer <dtroyer@gmail.com>2015-12-02 14:32:07 -0600
commitafd1b489ff2137ef1ee0eef1ec1c202f2e1ac899 (patch)
tree238f8c06641923d06bbd465f6fd479f6d1898714 /doc/source/developing.rst
parent40459b25e0584559dd1713a5654138ee3f43acd0 (diff)
downloadpython-openstackclient-afd1b489ff2137ef1ee0eef1ec1c202f2e1ac899.tar.gz
Add reno for release notes management
Change-Id: Iaaf3f9ca7cb431e41adfb2a052e01e2240a63a07
Diffstat (limited to 'doc/source/developing.rst')
-rw-r--r--doc/source/developing.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/source/developing.rst b/doc/source/developing.rst
index c41fbf34..9f8e55ca 100644
--- a/doc/source/developing.rst
+++ b/doc/source/developing.rst
@@ -98,6 +98,41 @@ create HTML docs, run the following:
The resultant HTML will be the ``doc/build/html`` directory.
+Release Notes
+-------------
+
+The release notes for a patch should be included in the patch. See the
+`Project Team Guide`_ for more information on using reno in OpenStack.
+
+.. _`Project Team Guide`: http://docs.openstack.org/project-team-guide/release-management.html#managing-release-notes
+
+If any of the following applies to the patch, a release note is required:
+
+* The deployer needs to take an action when upgrading
+* The plugin interface changes
+* A new feature is implemented
+* A command or option is removed
+* Current behavior is changed
+* A security bug is fixed
+
+Reno is used to generate release notes. Please read the docs for details. In summary, use
+
+.. code-block:: bash
+
+ $ tox -e venv -- reno new <bug-,bp-,whatever>
+
+Then edit the sample file that was created and push it with your change.
+
+To see the results:
+
+.. code-block:: bash
+
+ $ git commit # Commit the change because reno scans git log.
+
+ $ tox -e releasenotes
+
+Then look at the generated release notes files in releasenotes/build/html in your favorite browser.
+
Testing new code
----------------