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
This commit is contained in:
Brian Haley 2018-09-13 09:20:03 -06:00
parent 17bc8d851e
commit 2cbb10eb3f
6 changed files with 64 additions and 23 deletions

View File

@ -242,3 +242,4 @@
- neutron-tempest-plugin-jobs-queens
- check-requirements
- tempest-plugin-jobs
- release-notes-jobs-python3

View File

@ -10,3 +10,4 @@ It contains the tempest plugin for the functional testing of Neutron Project.
* Documentation: https://docs.openstack.org/neutron/latest/
* Source: https://git.openstack.org/cgit/openstack/neutron-tempest-plugin
* Bugs: https://bugs.launchpad.net/neutron
* Release notes: https://docs.openstack.org/releasenotes/neutron-tempest-plugin/

View File

@ -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.

View File

@ -52,12 +52,12 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'neutron_tempest_plugin Release Notes'
copyright = u'2017, OpenStack Developers'
project = u'Neutron Tempest Plugin Release Notes'
copyright = u'2017, Neutron Tempest Plugin Developers'
# openstackdocstheme options
repository_name = 'openstack/openstack'
bug_project = 'neutron_tempest_plugin'
repository_name = 'openstack/neutron-tempest-plugin'
bug_project = 'neutron'
bug_tag = ''
# The version info for the project you're documenting, acts as replacement for
@ -191,7 +191,7 @@ html_static_path = ['_static']
# html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'neutron_tempest_pluginReleaseNotesdoc'
htmlhelp_basename = 'NeutronTempestPluginReleaseNotesdoc'
# -- Options for LaTeX output ---------------------------------------------
@ -211,9 +211,9 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'neutron_tempest_pluginReleaseNotes.tex',
u'neutron_tempest_plugin Release Notes Documentation',
u'OpenStack Foundation', 'manual'),
('index', 'NeutronTempestPluginReleaseNotes.tex',
u'Neutron Tempest Plugin Release Notes Documentation',
u'Neutron Tempest Plugin Developers', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
@ -242,9 +242,9 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'neutron_tempest_pluginrereleasenotes',
u'neutron_tempest_plugin Release Notes Documentation',
[u'OpenStack Foundation'], 1)
('index', 'NeutronTempestPluginrereleasenotes',
u'Neutron Tempest Plugin Release Notes Documentation',
[u'Neutron Tempest Plugin Developers'], 1)
]
# If true, show URL addresses after external links.
@ -257,9 +257,10 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'neutron_tempest_plugin ReleaseNotes',
u'neutron_tempest_plugin Release Notes Documentation',
u'OpenStack Foundation', 'neutron_tempest_pluginReleaseNotes',
('index', 'Neutron Tempest Plugin ReleaseNotes',
u'Neutron Tempest Plugin Release Notes Documentation',
u'Neutron Tempest Plugin Developers',
'NeutronTempestPluginReleaseNotes',
'One line description of project.',
'Miscellaneous'),
]

View File

@ -1,8 +1,13 @@
============================================
neutron_tempest_plugin Release Notes
============================================
======================================
Neutron Tempest Plugin Release Notes
======================================
.. toctree::
:maxdepth: 1
unreleased
.. toctree::
:maxdepth: 1
README.rst

View File

@ -1,5 +1,5 @@
[metadata]
name = neutron_tempest_plugin
name = neutron-tempest-plugin
summary = Tempest plugin for Neutron Project
description-file =
README.rst
@ -16,8 +16,7 @@ classifier =
Programming Language :: Python :: 2
Programming Language :: Python :: 2.7
Programming Language :: Python :: 3
Programming Language :: Python :: 3.3
Programming Language :: Python :: 3.4
Programming Language :: Python :: 3.5
[files]
packages =
@ -33,11 +32,11 @@ build-dir = doc/build
upload-dir = doc/build/html
[compile_catalog]
directory = neutron/locale
domain = neutron
directory = neutron_tempest_plugin/locale
domain = neutron-tempest-plugin
[update_catalog]
domain = neutron_tempest_plugin
domain = neutron-tempest-plugin
output_dir = neutron_tempest_plugin/locale
input_file = neutron_tempest_plugin/locale/neutron_tempest_plugin.pot