From f3f471b41e6702d30ff45b4fb25b8b84bb030b52 Mon Sep 17 00:00:00 2001 From: Michal Nasiadka Date: Fri, 14 Feb 2020 11:03:02 +0100 Subject: [Community goal] Update the contributor guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Radosław Piliszek Change-Id: I50e2bf6aac38624851edb15ecb108cade469ddad Story: #2007236 Task: #38531 --- doc/source/contributor/release-notes.rst | 45 ++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 doc/source/contributor/release-notes.rst (limited to 'doc/source/contributor/release-notes.rst') diff --git a/doc/source/contributor/release-notes.rst b/doc/source/contributor/release-notes.rst new file mode 100644 index 000000000..854fc88fc --- /dev/null +++ b/doc/source/contributor/release-notes.rst @@ -0,0 +1,45 @@ +.. _release-notes: + +============= +Release notes +============= + +Kolla uses the following release notes sections: + +- ``features`` --- for new features or functionality; these should ideally + refer to the blueprint being implemented; +- ``fixes`` --- for fixes closing bugs; these must refer to the bug being + closed; +- ``upgrade`` --- for notes relevant when upgrading from previous version; + these should ideally be added only between major versions; required when + the proposed change affects behaviour in a non-backwards compatible way or + generally changes something impactful; +- ``deprecations`` --- to track deprecated features; relevant changes may + consist of only the commit message and the release note; +- ``prelude`` --- filled in by the PTL before each release or RC. + +Other release note types may be applied per common sense. +Each change should include a release note unless being a ``TrivialFix`` +change or affecting only docs or CI. Such changes should `not` include +a release note to avoid confusion. +Remember release notes are mostly for end users which, in case of Kolla, +are OpenStack administrators/operators. +In case of doubt, the core team will let you know what is required. + +To add a release note, run the following command: + +.. code-block:: console + + tox -e venv -- reno new + +All release notes can be inspected by browsing ``releasenotes/notes`` +directory. + +To generate release notes in HTML format in ``releasenotes/build``, run: + +.. code-block:: console + + tox -e releasenotes + +Note this requires the release note to be tracked by ``git`` so you +have to at least add it to the ``git``'s staging area. -- cgit v1.2.3