Mainline¶
2.0.2¶
Bug 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
2.0.0¶
This release includes a significant rewrite of the internal logic of reno to access git data through the dulwich library instead of the git command line porcelain.
New Features¶
- Reno now supports having a config.yaml file in your release notes directory. It will search for file in the directory specified by --rel-notes-dir and parse it. It will apply whatever options are valid for that particular command. If an option is not relevant to a particular sub-command, it will not attempt to apply them.
- Explicitly allow reno to scan starting from a tag by specifying the tag where a branch name would otherwise be used.
- Add logic to allow reno to detect a branch that has been marked as end-of-life using the OpenStack community’s process of tagging the HEAD of a stable/foo branch foo-eol before deleting the branch. This means that references to “stable/foo” are translated to “foo-eol” when the branch does not exist, and that Sphinx directives do not need to be manually updated.
- Set the default value of the reporoot argument for all command line programs to ”.” and make it an optional parameter.
- Automatically stop scanning branches at the point where they diverge from master. This avoids having release notes from older versions, that appear on master before the branch, from showing up in the versions from the branch. This logic is only applied to branches created from master.
- Add a new configuration option, stop_at_branch_base, to control whether or not the scanner stops looking for changes at the point where a branch diverges from master. The default is True, meaning that the scanner does stop. A false value means that versions that appear on master from a point earlier than when the branch was created will be included when scanning the branch for release notes.
- Reno now supports to set through template attribute in config.yaml a custom template which will be used by reno new to create notes.
- Reno now enables with reno new --edit to create a note and edit it with your editor (defined with EDITOR environment variable).
1.5.0¶
New Features¶
- Add the ability to limit queries by stopping at an “earliest version”. This is intended to be used when scanning a branch, for example, to stop at a point when the branch was created and not include all of the history from the parent branch.
1.4.0¶
New Features¶
- Add a flag to collapse pre-release notes into their final release, if the final release tag is present.
1.3.0¶
Bug Fixes¶
- Fixes bug 1522153 so that notes added in commits that are merged after tags are associated with the correct version.
1.1.0¶
New Features¶
- Add the --verbose, -v, and -q options to the command line tool for producing different levels of debug output.
Bug Fixes¶
- Fix bug 1517175 to ensure that all tagged versions are detected and that notes are associated with the correct version numbers.
1.0.0¶
New Features¶
Add the sphinx extension for integration with documentation builds.
Support note entries that span multiple lines using preformatted syntax in YAML by prefixing the list entry with |.
For example:
- | This entry has two paragraphs. This is the second.
Upgrade Notes¶
Change the order of the slug and UUID value in the note filename so the slug comes before the UUID to make tab completion easier to use.
Older files are still supported, and can be renamed to use the new style.