Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
Brian Haley
committed
Sep 13, 2018
1 parent
17bc8d8
commit 2cbb10e
Showing
6 changed files
with
64 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -242,3 +242,4 @@ | |
- neutron-tempest-plugin-jobs-queens | ||
- check-requirements | ||
- tempest-plugin-jobs | ||
- release-notes-jobs-python3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
========================================== | ||
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 <http://lists.openstack.org/pipermail/openstack-dev/2015-November/078301.html>`_. | ||
|
||
Writing release notes | ||
--------------------- | ||
|
||
For information on how to create release notes, please consult the | ||
`reno documentation <https://docs.openstack.org/reno/latest/user/usage.html>`__. | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,13 @@ | ||
============================================ | ||
neutron_tempest_plugin Release Notes | ||
============================================ | ||
====================================== | ||
Neutron Tempest Plugin Release Notes | ||
====================================== | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
unreleased | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
README.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters