openstack/cinder
Code Issues Proposed changes

Fix invalid yaml in reno template

Browse Source 
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
This commit is contained in:
Eric Harney 2021-03-11 10:35:46 -05:00
parent a4e64d839f
commit 7f84fff321
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
reno.yaml
View File

@ -8,13 +8,13 @@ template: |
Additional instructions available at Additional instructions available at
https://docs.openstack.org/cinder/latest/contributor/releasenotes.html https://docs.openstack.org/cinder/latest/contributor/releasenotes.html
Replace this text with content to appear at the top of the section for this Replace this text with content to appear at the top of the section for
release. All of the prelude content is merged together and then rendered this release. All of the prelude content is merged together and then
separately from the items listed in other parts of the file, so the text rendered separately from the items listed in other parts of the file, so
needs to be worded so that both the prelude and the other items make sense the text needs to be worded so that both the prelude and the other items
when read independently. This may mean repeating some details. Not every make sense when read independently. This may mean repeating some details.
release note requires a prelude. Usually only notes describing major Not every release note requires a prelude. Usually only notes describing
features or adding release theme details should have a prelude. major features or adding release theme details should have a prelude.
features: features:
- | - |
List new features here, or remove this section. All of the list items in List new features here, or remove this section. All of the list items in
@ -70,7 +70,8 @@ template: |
text needs to be worded so that it does not depend on any information only 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 available in another section, such as the prelude. This may mean repeating
some details. Examples for core code fixes, and driver fixes: some details. Examples for core code fixes, and driver fixes:
- `Bug #1889758 <https://bugs.launchpad.net/cinder/+bug/1889758>`_: Fix - |
`Bug #1889758 <https://bugs.launchpad.net/cinder/+bug/1889758>`_: Fix
revert to snapshot not working for non admin users when using the revert to snapshot not working for non admin users when using the
snapshot's name. snapshot's name.
- | - |