From 7f84fff321a0c9d9f3c69ae8110c2e0413fbc870 Mon Sep 17 00:00:00 2001 From: Eric Harney Date: Thu, 11 Mar 2021 10:35:46 -0500 Subject: [PATCH] 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 --- reno.yaml | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/reno.yaml b/reno.yaml index 9f79b25ba10..55c9fa05e54 100644 --- a/reno.yaml +++ b/reno.yaml @@ -8,13 +8,13 @@ template: | 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. + 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 @@ -70,7 +70,8 @@ template: | 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 `_: Fix + - | + `Bug #1889758 `_: Fix revert to snapshot not working for non admin users when using the snapshot's name. - |