Difference between revisions of "Trove/create-release-notes-with-reno"
< Trove
(Created page with "= Creating release notes with Reno = For the Mitaka Cycle the release notes are going to be automatically generated from source with Reno. When a new feature is commited we...") |
(→Creating release notes with Reno) |
||
| Line 11: | Line 11: | ||
## http://docs.openstack.org/developer/reno/usage.html#editing-a-release-note | ## http://docs.openstack.org/developer/reno/usage.html#editing-a-release-note | ||
# Commit the file with the feature | # Commit the file with the feature | ||
| + | |||
| + | = Building the release notes = | ||
| + | |||
| + | There is a jenkins job that will run that will generate the release notes. To build the release notes manually to verify them you can easily use the tox cmd to build them. | ||
| + | |||
| + | # tox -e releasenotes | ||
| + | |||
Easy enough! | Easy enough! | ||
Latest revision as of 21:10, 2 December 2015
Creating release notes with Reno
For the Mitaka Cycle the release notes are going to be automatically generated from source with Reno.
When a new feature is commited we should have a new release notes page that highlights the changes made. These release notes will be used for deployers, users, and developers. There are a few steps that need to be taken in order for this to happen smoothly.
- Generate a new release notes page
- tox -e venv -- reno new my-new-feature
- http://docs.openstack.org/developer/reno/usage.html#creating-new-release-notes
- Edit the release note file and fill in the fields
- Commit the file with the feature
Building the release notes
There is a jenkins job that will run that will generate the release notes. To build the release notes manually to verify them you can easily use the tox cmd to build them.
- tox -e releasenotes
Easy enough!
