From a372277240edc82f9409ad837221292bd09761a8 Mon Sep 17 00:00:00 2001 From: Samuel Matzek Date: Tue, 17 May 2016 10:00:53 -0500 Subject: [PATCH] Docs: Add note about releasenotes local build I was not aware that the releasenotes build only runs against committed changes. Developers that run it before committing their release note change to git will get a "false positive" and may push changes to review that then waste resources failing in the gate. Change-Id: I99a6a3106aacdf1df268c56eeb8c6e3c2e6f2104 --- doc/source/developer-docs/scripts.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/source/developer-docs/scripts.rst b/doc/source/developer-docs/scripts.rst index bd51ecfaa1..0b46f43cd7 100644 --- a/doc/source/developer-docs/scripts.rst +++ b/doc/source/developer-docs/scripts.rst @@ -180,6 +180,11 @@ Release notes may be built locally by executing: .. _the reno tool: http://docs.openstack.org/developer/reno/usage.html +.. note:: + + The ``releasenotes`` build argument only tests committed changes. + Ensure your local changes are committed before running the + ``releasenotes`` build. Gating ^^^^^^