Michał Dulko 619d28bc45 Remove driver interface changes from reno devref

Updating reno guideline in devref to reflect latest discussion at the
IRC meeting:

<smcginnis> We really only need release notes for things that would be
good to tell deployers and end users.
<smcginnis> Internal technical details would just be confusing to most
of them, so they definitely should not have a RL.

This commit removes the line stating that we should add a release note
with the driver interfaces changes.

Change-Id: Ibcca37c85e544aa7783bc08cefd1833af87acd5d

2016-09-09 10:28:37 +02: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.

1.8 KiB Raw Blame History

Release notes

1.8 KiB

Raw Blame History