We are tickled pink to announce the release of: reno 2.1.0: RElease NOtes manager The source is available from: http://git.openstack.org/cgit/openstack/reno Download the package from: https://pypi.python.org/pypi/reno Please report issues through launchpad: http://bugs.launchpad.net/reno For more details, please see below. 2.1.0 ^^^^^ New 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 works for the OpenStack practice of creating branches named after the stable series of releases. * Add a configuration option "sections" to hold the list of permitted section identifiers and corresponding display names. This also determines the order in which sections are collated. * Add the ability to specify regular expressions to a define a customised versioning scheme for release tags and pre-release tags. By default this change supports the current versioning scheme used by 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: release_tag_re: 'v\d\.\d\.\d(rc\d+)?' pre_release_tag_re: '(?P<pre_release>rc\d+$)' * Include the local working copy when scanning the history of the current branch. Notes files must at least be staged to indicate that they will eventually be part of the history, but subsequent changes to the file do not need to also be staged to be seen. * 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 report output now includes debugging details with the filename and sha for the version of the content used to indicate where the content is from to assist with debugging formatting or content issues. Bug Fixes ********* * Fixes the logic for determining how far back in history to look when scanning a given branch. Reno now looks for the base of the "previous" branch, as determined by looking at branches matching "branch_name_re" in lexical order. This may not work if branches are created using version numbers as their names. Changes in reno 2.0.3..2.1.0 ---------------------------- 65a82c3 uncap pbr dependency ce925cc clarify automatic inclusion of prelude section 961f40c trim Newton history to avoid duplication 081a414 make sections configurable b0ba2ee add filename and sha in comments in report output a92bef6 add sha info to ChangeTracker debug output 10ccdda fix some minor formatting issues with release notes 7ecf633 fix reference to config.yaml 962e908 documentation improvements efceabc ignore staged files that are not notes 4dd403d show full history c8904a6 remove cruft from readme 9e2be7f try to discover the repository root in sphinx builds d464c7e only show recent releases on the current series pages 1db83bd fix logic for deciding when to stop scanning a branch b8df9a0 Remove support for py33 b11e2fb add a null logging handler 4af98bb do not test python 3.4 by default 5003ea2 Add support for custom tag version schemes f8fc8f9 teach the scanner to look at uncommitted files c2018e1 add the irc channel to the readme file d9db082 Remove link to modindex 0043296 refactor change tracking in scanner 8756c1d tone down the warning for missing configuration file Diffstat (except docs and test files) ------------------------------------- README.rst | 60 ++- ...fig-option-branch-name-re-8ecfe93195b8824e.yaml | 15 + .../config-option-sections-9c68b070698e984a.yaml | 7 + .../custom-tag-versions-d02028b6d35db967.yaml | 15 + ...fix-branch-base-detection-95300805f26a0c15.yaml | 3 +- .../include-working-copy-d0aed2e77bb095e6.yaml | 7 + .../show-less-unreleased-802781a1a3bf110e.yaml | 8 + ...w-note-filename-in-report-a1118c917588b58d.yaml | 7 + reno/__init__.py | 6 + reno/config.py | 50 +- reno/formatter.py | 22 +- reno/report.py | 1 + reno/scanner.py | 521 +++++++++++++++------ reno/sphinxext.py | 5 + requirements.txt | 2 +- setup.cfg | 1 - test-requirements.txt | 2 +- tox.ini | 2 +- 24 files changed, 930 insertions(+), 304 deletions(-) Requirements updates -------------------- diff --git a/requirements.txt b/requirements.txt index 7e2b9e9..5fb4f35 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5 +5 @@ -pbr<2.0,>=1.4 +pbr>=1.4 diff --git a/test-requirements.txt b/test-requirements.txt index ce26e18..2f939a5 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5 +5 @@ -hacking<0.11,>=0.10.0 +hacking>=0.12.0,!=0.13.0,<0.14 # Apache-2.0