From 0d3b531de7a53e7678781c45587ee4e5afd73643 Mon Sep 17 00:00:00 2001 From: Samuel Matzek Date: Thu, 12 May 2016 10:31:36 -0500 Subject: [PATCH] Document the Release Notes build This adds documentation for the Release Notes build and how to run the build locally so contributors know that the gate exists and to run the build locally before putting changes up for review. Change-Id: Id2a8d7d96edec5865bc71cf61afa70d13f9977dd --- doc/source/developer-docs/scripts.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/source/developer-docs/scripts.rst b/doc/source/developer-docs/scripts.rst index d9bd0b91fc..bd51ecfaa1 100644 --- a/doc/source/developer-docs/scripts.rst +++ b/doc/source/developer-docs/scripts.rst @@ -166,12 +166,30 @@ Documentation may be built locally by executing: .. _reStructuredText: http://docutils.sourceforge.net/rst.html +Release Notes Build +------------------- + +Release notes are generated using the `the reno tool`_ and compiled into +HTML using Sphinx. + +Release notes may be built locally by executing: + +.. code-block:: bash + + tox -e releasenotes + +.. _the reno tool: http://docs.openstack.org/developer/reno/usage.html + + Gating ^^^^^^ Every commit to OpenStack-Ansible is verified by OpenStack-CI through the following jobs: +* ``gate-openstack-ansible-releasenotes``: This job executes the + `Release Notes Build`_. + * ``gate-openstack-ansible-docs``: This job executes the `Documentation Build`_.