Getting Started with release notes

Release notes are a short descriptions describing what was fixed when we submit a patch that fixes a user facing bug.
At the end of a release, the release notes get rendered into a document that users and deployers can see what changed in the release.
In OpenStack we have a release notes manager called Reno.
Following are the steps that we follow:

        $ git review -d <change number>
     
To create a tox environment that will install our release note tool:

       $ tox -e releasenotes --notest

Then
      $ source .tox/releasenotes/bin/activate
      $ reno new bug-bugID

The reno tool will create a new file in releasenotes directory that we can open and edit accordingly as the file contains a bunch of different sections.
Detailed information can be viewed here.  

Popular Posts