diff options
| author | Zuul <zuul@review.opendev.org> | 2020-01-03 13:05:51 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2020-01-03 13:05:51 +0000 |
| commit | 34f748a8be5c1ba870dcd252e0e8fa3351fe7700 (patch) | |
| tree | 9ed95ad0d929ac6b02d11259f68eeef171a35b4e /doc | |
| parent | 90babe35d0e075ad15904bb2263e1dd019f10532 (diff) | |
| parent | f5e534b99f540c15816b472e2aa2626d201df4ea (diff) | |
| download | kolla-34f748a8be5c1ba870dcd252e0e8fa3351fe7700.tar.gz kolla-34f748a8be5c1ba870dcd252e0e8fa3351fe7700.zip | |
Merge "Docs: add new rules regarding release notes usage"
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/contributor/CONTRIBUTING.rst | 40 |
1 files changed, 35 insertions, 5 deletions
diff --git a/doc/source/contributor/CONTRIBUTING.rst b/doc/source/contributor/CONTRIBUTING.rst index 83632d44d..b598178bc 100644 --- a/doc/source/contributor/CONTRIBUTING.rst +++ b/doc/source/contributor/CONTRIBUTING.rst @@ -37,15 +37,45 @@ for learning, understanding and testing the `Gerrit Workflow Adding a release note ===================== -All new features should have a documented release note. To add a release note -run the following command: +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 <feature-being-added> + tox -e venv -- reno new <summary-line-with-dashes> -Typically in this project we do not add release notes for bug fixes. Upgrade -notes can be extremely helpful for operators so these are encouraged. +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. Adding a new service ==================== |