cinder/reno.yaml
Eric Harney 7f84fff321 Fix invalid yaml in reno template
This fixes two issues with the reno yaml template.

The prelude paragraph has a line longer than 80 chars.

Add a newline for the bug # entry.  This prevents an error
where yamllint complains that a token cannot start with
a backtick, if the bug # entry is used as the first item
in the "fixes" section.

Change-Id: I743e9999a42c6a7a978c88b16f02b7c5e6e826c7
2021-03-11 10:35:46 -05:00

90 lines
4.4 KiB
YAML

---
# Ignore the kilo-eol tag because that branch does not work with reno
# and contains no release notes.
closed_branch_tag_re: "(.+)(?<!kilo)-eol"
template: |
---
prelude: >
Additional instructions available at
https://docs.openstack.org/cinder/latest/contributor/releasenotes.html
Replace this text with content to appear at the top of the section for
this release. All of the prelude content is merged together and then
rendered separately from the items listed in other parts of the file, so
the text needs to be worded so that both the prelude and the other items
make sense when read independently. This may mean repeating some details.
Not every release note requires a prelude. Usually only notes describing
major features or adding release theme details should have a prelude.
features:
- |
List new features here, or remove this section. All of the list items in
this section are combined when the release notes are rendered, so the text
needs to be worded so that it does not depend on any information only
available in another section, such as the prelude. This may mean repeating
some details. Examples for core features and driver specific features:
- |
We can now limit the number of concurrent backup/restore operations that
a Cinder backup service can perform using the ``backup_max_operations``
configuration option.
- |
RBD driver: Add support for volume manage and unmanage operations.
issues:
- |
List known issues here, or remove this section. All of the list items in
this section are combined when the release notes are rendered, so the text
needs to be worded so that it does not depend on any information only
available in another section, such as the prelude. This may mean repeating
some details.
upgrade:
- |
List upgrade notes here, or remove this section. All of the list items in
this section are combined when the release notes are rendered, so the text
needs to be worded so that it does not depend on any information only
available in another section, such as the prelude. This may mean repeating
some details.
deprecations:
- |
List deprecations notes here, or remove this section. All of the list
items in this section are combined when the release notes are rendered, so
the text needs to be worded so that it does not depend on any information
only available in another section, such as the prelude. This may mean
repeating some details.
critical:
- |
Add critical notes here, or remove this section. All of the list items in
this section are combined when the release notes are rendered, so the text
needs to be worded so that it does not depend on any information only
available in another section, such as the prelude. This may mean repeating
some details.
security:
- |
Add security notes here, or remove this section. All of the list items in
this section are combined when the release notes are rendered, so the text
needs to be worded so that it does not depend on any information only
available in another section, such as the prelude. This may mean repeating
some details.
fixes:
- |
Add normal bug fixes here, or remove this section. All of the list items
in this section are combined when the release notes are rendered, so the
text needs to be worded so that it does not depend on any information only
available in another section, such as the prelude. This may mean repeating
some details. Examples for core code fixes, and driver 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.
- |
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.
other:
- |
Add other notes here, or remove this section. All of the list items in
this section are combined when the release notes are rendered, so the text
needs to be worded so that it does not depend on any information only
available in another section, such as the prelude. This may mean repeating
some details.