
reno includes release notes touched in a target release even if they are added from past releases. The recent release note cleanup I made as part of doc8 adoption and some other cleanup touched release notes from past releases. As a result, we see several number of release notes from past release in the Pike release notes unexpectedly. Also adds a warning note to the release notes howto page Change-Id: I127f96896488e9992d9309d76055b4883f6a62f3 Closes-Bug: #1708560
1.0 KiB
1.0 KiB
Neutron Release Notes Howto
Release notes are a new feature for documenting new features in OpenStack projects. Background on the process, tooling, and methodology is documented in a mailing list post by Doug Hellmann.
Writing release notes
For information on how to create release notes, please consult the reno documentation.
Maintaining release notes
Warning
Avoid modifying an existing release note file even though it is related to your change. If you modify a release note file of a past release, the whole content will be shown in a latest release. The only allowed case is to update a release note in a same release.
If you need to update a release note of a past release, edit a corresponding release note file in a stable branch directly.