Docs: Improve contributor's release notes
Add some specifics on the contributor's release notes page regarding bug references and driver patches. Change-Id: I39b818bd560bf57dc7e52583061b6ceb87686f45
This commit is contained in:
parent
c315930e75
commit
d2182aac3a
@ -45,6 +45,70 @@ If the following applies to the patch, a release note is required:
|
||||
|
||||
* REST API changes
|
||||
|
||||
Bugs
|
||||
----
|
||||
|
||||
For bug fixes, release notes must include the bug number in Launchpad with a
|
||||
link to it as a RST link like in the following example:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
---
|
||||
fixes:
|
||||
- |
|
||||
`Bug #1889758 <https://bugs.launchpad.net/cinder/+bug/1889758>`_: Fix
|
||||
revert to snapshot not working for non admin users when using the
|
||||
snapshot's name.
|
||||
|
||||
Drivers
|
||||
-------
|
||||
|
||||
For release notes related to a specific driver -be it volume, backup, or
|
||||
zone manager- the release note line must start with ``<driver-name> driver:``.
|
||||
For example:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
---
|
||||
features:
|
||||
- |
|
||||
RBD driver: Add support for volume manage and unmanage operations.
|
||||
|
||||
When fixing a driver bug we must not only have the driver name prefix but also
|
||||
the bug number and link:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
---
|
||||
fixes:
|
||||
- |
|
||||
Brocade driver `bug #1866860
|
||||
<https://bugs.launchpad.net/cinder/+bug/1889758>`_: Fix
|
||||
``AttributeError`` when using ``REST_HTTP`` or ``REST_HTTPS`` as the
|
||||
``fc_southbound_protocol`` option and an exception is raised by the
|
||||
client.
|
||||
|
||||
There are times when a bug affects multiple drivers. In such a cases we must
|
||||
list each of the driver as an independent item following above rules:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
---
|
||||
fixes:
|
||||
- |
|
||||
Unity driver `bug #1881108
|
||||
<https://bugs.launchpad.net/cinder/+bug/1881108>`_: Fix leaving leftover
|
||||
devices on the host when validation of the attached volume fails on some
|
||||
cloning cases and create volume from snapshot.
|
||||
- |
|
||||
Kaminario driver `bug #1881108
|
||||
<https://bugs.launchpad.net/cinder/+bug/1881108>`_: Fix leaving leftover
|
||||
devices on the host when validation of the attached volume fails on some
|
||||
cloning cases and create volume from snapshot.
|
||||
|
||||
Creating the note
|
||||
-----------------
|
||||
|
||||
Cinder uses `reno <https://docs.openstack.org/reno/latest/>`_ to
|
||||
generate release notes. Please read the docs for details. In summary, use
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user