openstack
/
reno
Code Issues Proposed changes

fix some minor formatting issues with release notes 

- Use monospaced fonts for git refs
- Put config.yaml excerpts into a code block
- Hyperlink bug references

Change-Id: I3ff8f65d1886f25746927ef2ad35d1db87439d2c
This commit is contained in:
Adam Spiers 2017-02-21 14:04:13 -05:00
parent 7ecf63312f
commit 10ccdda0eb
4 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
releasenotes/notes/config-option-branch-name-re-8ecfe93195b8824e.yaml
View File

@ -3,7 +3,7 @@ features:
- |
Add a configuration option ``branch_name_re`` to hold a regular expression
for choosing "interesting" branches when trying to automatically detect
how far back the scanner should look. The default is 'stable/.+', which
how far back the scanner should look. The default is ``stable/.+``, which
works for the OpenStack practice of creating branches named after the
stable series of releases.
fixes:

8
releasenotes/notes/custom-tag-versions-d02028b6d35db967.yaml
View File

@ -8,8 +8,8 @@ features:
OpenStack.
To customise, update the config.yaml file with the appropriate values.
For example, for tags with versions like 'v1.0.0' and pre-release
versions like 'v1.0.0rc1' the following could be added to config.yaml:
For example, for tags with versions like ``v1.0.0`` and pre-release
versions like ``v1.0.0rc1`` the following could be added to config.yaml::
release_tag_re: 'v\d\.\d\.\d(rc\d+)?'
pre_release_tag_re: '(?P<pre_release>rc\d+$)'
release_tag_re: 'v\d\.\d\.\d(rc\d+)?'
pre_release_tag_re: '(?P<pre_release>rc\d+$)'

3
releasenotes/notes/fix-branch-base-detection-95300805f26a0c15.yaml
View File

@ -4,4 +4,5 @@ fixes:
Fix a problem with the way reno automatically detects the initial
version in a branch that prevented it from including all of the
notes associated with a release, especially if the branch was
created at a pre-release version number. Bug #1652092
created at a pre-release version number.
`Bug #1652092 <https://bugs.launchpad.net/reno/+bug/1652092>`__

9
releasenotes/notes/show-less-unreleased-802781a1a3bf110e.yaml
View File

@ -1,7 +1,8 @@
---
features:
- |
The scanner for the "current" branch (usually master) now stops when it
encounters the base of an earlier branch matching the branch_name_re config
option. This results in less history appearing on the unreleased pages,
while still actually showing the current series and any unreleased notes.
The scanner for the "current" branch (usually ``master``) now stops
when it encounters the base of an earlier branch matching the
``branch_name_re`` config option. This results in less history
appearing on the unreleased pages, while still actually showing
the current series and any unreleased notes.