Jump to: navigation, search


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.

  1. Generate a new release notes page
    1. tox -e venv -- reno new my-new-feature
    2. http://docs.openstack.org/developer/reno/usage.html#creating-new-release-notes
  2. Edit the release note file and fill in the fields
    1. http://docs.openstack.org/developer/reno/usage.html#editing-a-release-note
  3. 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.

  1. tox -e releasenotes

Easy enough!