openstack
/
neutron-tempest-plugin
Code Issues Proposed changes
neutron-tempest-plugin/releasenotes/source
History
Brian Haley 2cbb10eb3f Add release notes job to zuul template 
We are not running the release notes job, so are unable to
see the built release notes when they are included in a patch.
Add it as in the other neutron repos.

Also added a similar README.rst as the neutron repo to give
the basic info on release note generation, and fixed up
various issues in the configuration description.

Change-Id: I98ffed3ed77a16bba59cae69a73cb699ddb175fb
 		2018-09-13 15:26:04 -06:00
..
_static Apply cookiecutter to newly split project 2017-09-07 22:23:55 +05:30
_templates Apply cookiecutter to newly split project 2017-09-07 22:23:55 +05:30
README.rst Add release notes job to zuul template 2018-09-13 15:26:04 -06:00
conf.py Add release notes job to zuul template 2018-09-13 15:26:04 -06:00
index.rst Add release notes job to zuul template 2018-09-13 15:26:04 -06:00
unreleased.rst Apply cookiecutter to newly split project 2017-09-07 22:23:55 +05:30

README.rst

Neutron Tempest Plugin 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.

Please keep the following in your mind when you write release notes.

  • Avoid using "prelude" section for individual release notes. "prelude" section is for general comments about the release.
  • Use one entry per section (like "feature" or "upgrade"). All entries which belong to a same release will be merged and rendered, so there is less meaning to use multiple entries by a single topic.

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.