openstack
/
reno
Code Issues Proposed changes
Release notes management tool
243 Commits 2 Branches 53 Tags 2.6 MiB
Python 100%
Go to file
Doug Hellmann bc3d1241dd allow release notes sections to be single strings 
Release notes entries may now be made up of single strings. This
simplifies formatting for smaller notes, and eliminates a class of
errors associated with escaping reStructuredText inside YAML lists.

Change-Id: I7f2fb2d2fd16f49e7ee061582df7bcdd4116f215
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
 		2017-06-05 15:42:06 -04:00
doc/source Document how reno handles eol branches in config 2017-06-01 14:30:43 -04:00
examples/notes allow release notes sections to be single strings 2017-06-05 15:42:06 -04:00
releasenotes/notes allow release notes sections to be single strings 2017-06-05 15:42:06 -04:00
reno allow release notes sections to be single strings 2017-06-05 15:42:06 -04:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:55:10 +00:00
.gitignore ignore all coverage output files 2016-06-22 13:47:59 -04:00
.gitreview Initial Cookiecutter Commit. 2015-08-26 20:04:56 +00:00
.mailmap Initial Cookiecutter Commit. 2015-08-26 20:04:56 +00:00
.testr.conf Initial Cookiecutter Commit. 2015-08-26 20:04:56 +00:00
CONTRIBUTING.rst Initial Cookiecutter Commit. 2015-08-26 20:04:56 +00:00
HACKING.rst Initial Cookiecutter Commit. 2015-08-26 20:04:56 +00:00
LICENSE Initial Cookiecutter Commit. 2015-08-26 20:04:56 +00:00
MANIFEST.in Initial Cookiecutter Commit. 2015-08-26 20:04:56 +00:00
README.rst comment out openstack governance badges 2017-04-13 12:04:01 -04:00
babel.cfg Initial Cookiecutter Commit. 2015-08-26 20:04:56 +00:00
requirements.txt uncap pbr dependency 2017-03-01 11:15:18 -05:00
setup.cfg do not use sphinx 1.6.1 2017-05-17 14:44:03 -04:00
setup.py Initial Cookiecutter Commit. 2015-08-26 20:04:56 +00:00
test-requirements.txt Remove oslotest from test-requirements.txt 2017-05-25 07:05:59 +02:00
tox.ini add a lint command 2017-05-03 15:53:44 -04:00

README.rst

reno: A New Way to Manage Release Notes

Reno is a release notes manager designed with high throughput in mind, supporting fast distributed development teams without introducing additional development processes. Our goal is to encourage detailed and accurate release notes for every release.

Reno uses git to store its data, along side the code being described. This means release notes can be written when the code changes are fresh, so no details are forgotten. It also means that release notes can go through the same review process used for managing code and other documentation changes.

Reno stores each release note in a separate file to enable a large number of developers to work on multiple patches simultaneously, all targeting the same branch, without worrying about merge conflicts. This cuts down on the need to rebase or otherwise manually resolve conflicts, and keeps a development team moving quickly.

Reno also supports multiple branches, allowing release notes to be back-ported from master to maintenance branches together with the code for bug fixes.

Reno organizes notes into logical groups based on whether they describe new features, bug fixes, known issues, or other topics of interest to the user. Contributors categorize individual notes as they are added, and reno combines them before publishing.

Notes can be styled using reStructuredText directives, and reno's Sphinx integration makes it easy to incorporate release notes into automated documentation builds.

Notes are automatically associated with the release version based on the git tags applied to the repository, so it is not necessary to track changes manually using a bug tracker or other tool, or to worry that an important change will be missed when the release notes are written by hand all at one time, just before a release.

Modifications to notes are incorporated when the notes are shown in their original location in the history. This feature makes it possible to correct typos or otherwise fix a published release note after a release is made, but have the new note content associated with the original version number. Notes also can be deleted, eliminating them from future documentation builds.

Project Meta-data