4 Commits

Author SHA1 Message Date
Brian Rosmaita
75588809b5 Update release note info
- add a link to make the release note info easier to find in the
  contributor guide to increase the likelihood that people will
  actually follow the standard format
- add some guidance about using past tense to describe fixes
- update the sample notes to reflect the above

Change-Id: Iddf0b3de4ba44f9b14d2e144097b51fd7a4ccf61
2021-04-16 11:11:41 -04:00
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
Gorka Eguileor
6736945fe9 Reno: Use customized template
Even though we have updated the release notes instructions [1] we keep
forgetting to do it, so this patch adds a customized template to
Cinder's release notes to help developers remember.

The template includes a link to the contributor page where we explain
additional details as well as examples for normal and driver features
and fixes.

[1]: https://docs.openstack.org/cinder/latest/contributor/releasenotes.html

Change-Id: I6a57751310d0a52fba43aea3facac9207548f1ef
2020-10-06 13:28:45 +02:00
Sean McGinnis
cff7fffc36 Tell reno to ignore the kilo branch
When reno 3.x runs under setuptools, it scans all of the branches it can
find, including any that look like they're closed and have an -eol tag.
The old kilo branch in this repository has a jumbled history that
somehow makes it look like it should include tags that it doesn't. We
know that there are no release notes in that branch, because reno wasn't
adopted while it was open. The releasenotes/source/index.rst links to
separate release notes in the wiki.

This patch tells reno to ignore that branch so that it doesn't throw an
exception when it gets confused about the old tag.

Change-Id: Idd56c3f37d5786daae7181c36d38d267cbf1885c
Co-Authored-By: Doug Hellmann <doug@doughellmann.com>
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2020-02-15 14:15:18 -06:00