From 10ccdda0eb8c1932dc4c8c2a66f46f0e7cf8bb0a Mon Sep 17 00:00:00 2001 From: Adam Spiers Date: Tue, 21 Feb 2017 14:04:13 -0500 Subject: [PATCH] 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 --- .../config-option-branch-name-re-8ecfe93195b8824e.yaml | 2 +- .../notes/custom-tag-versions-d02028b6d35db967.yaml | 8 ++++---- .../fix-branch-base-detection-95300805f26a0c15.yaml | 3 ++- .../notes/show-less-unreleased-802781a1a3bf110e.yaml | 9 +++++---- 4 files changed, 12 insertions(+), 10 deletions(-) diff --git a/releasenotes/notes/config-option-branch-name-re-8ecfe93195b8824e.yaml b/releasenotes/notes/config-option-branch-name-re-8ecfe93195b8824e.yaml index c3150ca..d776c0c 100644 --- a/releasenotes/notes/config-option-branch-name-re-8ecfe93195b8824e.yaml +++ b/releasenotes/notes/config-option-branch-name-re-8ecfe93195b8824e.yaml @@ -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: diff --git a/releasenotes/notes/custom-tag-versions-d02028b6d35db967.yaml b/releasenotes/notes/custom-tag-versions-d02028b6d35db967.yaml index 75d0871..c1ce543 100644 --- a/releasenotes/notes/custom-tag-versions-d02028b6d35db967.yaml +++ b/releasenotes/notes/custom-tag-versions-d02028b6d35db967.yaml @@ -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: '(?Prc\d+$)' + release_tag_re: 'v\d\.\d\.\d(rc\d+)?' + pre_release_tag_re: '(?Prc\d+$)' diff --git a/releasenotes/notes/fix-branch-base-detection-95300805f26a0c15.yaml b/releasenotes/notes/fix-branch-base-detection-95300805f26a0c15.yaml index 10eaf58..ffbc8a0 100644 --- a/releasenotes/notes/fix-branch-base-detection-95300805f26a0c15.yaml +++ b/releasenotes/notes/fix-branch-base-detection-95300805f26a0c15.yaml @@ -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 \ No newline at end of file + created at a pre-release version number. + `Bug #1652092 `__ diff --git a/releasenotes/notes/show-less-unreleased-802781a1a3bf110e.yaml b/releasenotes/notes/show-less-unreleased-802781a1a3bf110e.yaml index 268c071..20673e0 100644 --- a/releasenotes/notes/show-less-unreleased-802781a1a3bf110e.yaml +++ b/releasenotes/notes/show-less-unreleased-802781a1a3bf110e.yaml @@ -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.