openstack/cinder
Code Issues Proposed changes
00519aef92
cinder/doc/source/contributor/releasenotes.rst
Brian Rosmaita 98e04c7b02 Ussuri contrib docs community goal 
This patch standardizes the CONTRIBUTING.rst file and adds the
required doc/source/contributor/contributing.rst

Change-Id: Icee34784ede414890704a5bd8a4b56000df49e53
2020-03-05 14:11:48 -05:00

1.8 KiB
Raw Blame History

Release notes

The release notes for a patch should be included in the patch.

If the following applies to the patch, a release note is required:

  • Upgrades
    • The deployer needs to take an action when upgrading
    • A new config option is added that the deployer should consider changing from the default
    • A configuration option is deprecated or removed
  • Features
    • A new feature or driver is implemented
    • Feature is deprecated or removed
    • Current behavior is changed
  • Bugs
    • A security bug is fixed
    • A long-standing or important bug is fixed
  • APIs
    • REST API changes

Cinder uses reno to generate release notes. Please read the docs for details. In summary, use

$ tox -e venv -- reno new <bug-,bp-,whatever>

Then edit the sample file that was created and push it with your change.

To see the results:

$ git commit  # Commit the change because reno scans git log.

$ tox -e releasenotes

Then look at the generated release notes files in releasenotes/build/html in your favorite browser.