[openstack-dev] [trove] Adding release notes to changes

Peter Stachowski peter at tesora.com
Sat Apr 16 16:14:28 UTC 2016

Just a note that certain character combinations cannot be used in the yaml file text as they are parsed (such as ': ' and '- ' that is a colon or dash with a space after). If you need to use either a colon or dash, then you cannot have a space, or you must enclosed the entire text in quotes. For bug numbers, it's probably easiest just to use a format like 'Bug 1234567' to avoid this issue.


-----Original Message-----
From: Amrith Kumar [mailto:amrith at tesora.com] 
Sent: April-16-16 11:07 AM
To: openstack-dev at lists.openstack.org
Subject: [openstack-dev] [trove] Adding release notes to changes


We are now using reno[1] for release notes in trove, trove-dashboard, and python-troveclient.

If you submit a change to any one of these repositories, that is going to be visible to a user (i.e. not changes that only impact tests, or are procedural changes relating to management of the repository etc.,) please DO add a release note.

For instructions on how to add a release note, please see [2].

Once you add a release note, please be sure to run

	tox -e releasenotes 

before you push your change set for review. It will save you a lot of time, and will spare the CI a lot of unnecessary testing.

If you are fixing a bug, please include the LP bug number(s) in the release note.

Some samples of release notes are provided in [3], [4], and [5].



[1] http://docs.openstack.org/developer/reno/

More information about the OpenStack-dev mailing list