From 6ea15a7f9d17498a66ed746be53d648b7d5ec968 Mon Sep 17 00:00:00 2001 From: Gage Hugo Date: Wed, 6 Jan 2021 16:22:46 -0600 Subject: [PATCH] Add reno job to Openstack-Helm With OSH now publishing charts regularly with each change, there needs to be a way to track these changes in order to track the changes between chart versions. This proposed change adds in a reno check job to publish notes based from the changes to each chart by version as a way to track and document all the changes that get made to OSH and published to tarballs.o.o. Change-Id: Iff8681c697957e4711754fc20b07fa6b728eb584 --- doc/requirements.txt | 1 + releasenotes/config.yaml | 31 ++++++++++++++++++++++ releasenotes/notes/aodh.yaml | 3 +++ releasenotes/notes/barbican.yaml | 3 +++ releasenotes/notes/ceilometer.yaml | 3 +++ releasenotes/notes/cinder.yaml | 3 +++ releasenotes/notes/designate.yaml | 3 +++ releasenotes/notes/glance.yaml | 3 +++ releasenotes/notes/heat.yaml | 3 +++ releasenotes/notes/horizon.yaml | 3 +++ releasenotes/notes/ironic.yaml | 3 +++ releasenotes/notes/keystone.yaml | 3 +++ releasenotes/notes/magnum.yaml | 3 +++ releasenotes/notes/mistral.yaml | 3 +++ releasenotes/notes/neutron.yaml | 3 +++ releasenotes/notes/nova.yaml | 3 +++ releasenotes/notes/octavia.yaml | 3 +++ releasenotes/notes/panko.yaml | 3 +++ releasenotes/notes/placement.yaml | 3 +++ releasenotes/notes/rally.yaml | 3 +++ releasenotes/notes/senlin.yaml | 3 +++ releasenotes/notes/tempest.yaml | 3 +++ releasenotes/source/conf.py | 42 ++++++++++++++++++++++++++++++ releasenotes/source/current.rst | 5 ++++ releasenotes/source/index.rst | 21 +++++++++++++++ tox.ini | 3 +++ zuul.d/project.yaml | 1 + 27 files changed, 164 insertions(+) create mode 100644 releasenotes/config.yaml create mode 100644 releasenotes/notes/aodh.yaml create mode 100644 releasenotes/notes/barbican.yaml create mode 100644 releasenotes/notes/ceilometer.yaml create mode 100644 releasenotes/notes/cinder.yaml create mode 100644 releasenotes/notes/designate.yaml create mode 100644 releasenotes/notes/glance.yaml create mode 100644 releasenotes/notes/heat.yaml create mode 100644 releasenotes/notes/horizon.yaml create mode 100644 releasenotes/notes/ironic.yaml create mode 100644 releasenotes/notes/keystone.yaml create mode 100644 releasenotes/notes/magnum.yaml create mode 100644 releasenotes/notes/mistral.yaml create mode 100644 releasenotes/notes/neutron.yaml create mode 100644 releasenotes/notes/nova.yaml create mode 100644 releasenotes/notes/octavia.yaml create mode 100644 releasenotes/notes/panko.yaml create mode 100644 releasenotes/notes/placement.yaml create mode 100644 releasenotes/notes/rally.yaml create mode 100644 releasenotes/notes/senlin.yaml create mode 100644 releasenotes/notes/tempest.yaml create mode 100644 releasenotes/source/conf.py create mode 100644 releasenotes/source/current.rst create mode 100644 releasenotes/source/index.rst diff --git a/doc/requirements.txt b/doc/requirements.txt index 5adfe777dd..9ef34773c3 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -5,3 +5,4 @@ sphinx>=2.0.0,!=2.1.0 # BSD sphinxcontrib-blockdiag>=1.1.0 openstackdocstheme>=2.2.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 diff --git a/releasenotes/config.yaml b/releasenotes/config.yaml new file mode 100644 index 0000000000..03b669d096 --- /dev/null +++ b/releasenotes/config.yaml @@ -0,0 +1,31 @@ +--- +branch: master +collapse_pre_releases: false +stop_at_branch_base: true +sections: + - [aodh, aodh Chart] + - [barbican, barbican Chart] + - [ceilometer, ceilometer Chart] + - [cinder, cinder Chart] + - [designate, designate Chart] + - [glance, glance Chart] + - [heat, heat Chart] + - [horizon, horizon Chart] + - [ironic, ironic Chart] + - [keystone, keystone Chart] + - [magnum, magnum Chart] + - [mistral, mistral Chart] + - [neutron, neutron Chart] + - [nova, nova Chart] + - [octavia, octavia Chart] + - [panko, panko Chart] + - [placement, placement Chart] + - [rally, rally Chart] + - [senlin, senlin Chart] + - [tempest, tempest Chart] + - [features, New Features] + - [issues, Known Issues] + - [upgrade, Upgrade Notes] + - [api, API Changes] + - [security, Security Issues] + - [fixes, Bug Fixes] diff --git a/releasenotes/notes/aodh.yaml b/releasenotes/notes/aodh.yaml new file mode 100644 index 0000000000..dba9893498 --- /dev/null +++ b/releasenotes/notes/aodh.yaml @@ -0,0 +1,3 @@ +--- +aodh: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/barbican.yaml b/releasenotes/notes/barbican.yaml new file mode 100644 index 0000000000..91f27b8602 --- /dev/null +++ b/releasenotes/notes/barbican.yaml @@ -0,0 +1,3 @@ +--- +barbican: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/ceilometer.yaml b/releasenotes/notes/ceilometer.yaml new file mode 100644 index 0000000000..eb7b71161c --- /dev/null +++ b/releasenotes/notes/ceilometer.yaml @@ -0,0 +1,3 @@ +--- +ceilometer: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/cinder.yaml b/releasenotes/notes/cinder.yaml new file mode 100644 index 0000000000..0a5a52a579 --- /dev/null +++ b/releasenotes/notes/cinder.yaml @@ -0,0 +1,3 @@ +--- +cinder: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/designate.yaml b/releasenotes/notes/designate.yaml new file mode 100644 index 0000000000..d4ee61f6a0 --- /dev/null +++ b/releasenotes/notes/designate.yaml @@ -0,0 +1,3 @@ +--- +designate: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/glance.yaml b/releasenotes/notes/glance.yaml new file mode 100644 index 0000000000..5e1d057817 --- /dev/null +++ b/releasenotes/notes/glance.yaml @@ -0,0 +1,3 @@ +--- +glance: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/heat.yaml b/releasenotes/notes/heat.yaml new file mode 100644 index 0000000000..ac15aca4da --- /dev/null +++ b/releasenotes/notes/heat.yaml @@ -0,0 +1,3 @@ +--- +heat: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/horizon.yaml b/releasenotes/notes/horizon.yaml new file mode 100644 index 0000000000..4a479c4616 --- /dev/null +++ b/releasenotes/notes/horizon.yaml @@ -0,0 +1,3 @@ +--- +horizon: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/ironic.yaml b/releasenotes/notes/ironic.yaml new file mode 100644 index 0000000000..9fdcaa3efc --- /dev/null +++ b/releasenotes/notes/ironic.yaml @@ -0,0 +1,3 @@ +--- +ironic: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/keystone.yaml b/releasenotes/notes/keystone.yaml new file mode 100644 index 0000000000..05e0405a19 --- /dev/null +++ b/releasenotes/notes/keystone.yaml @@ -0,0 +1,3 @@ +--- +keystone: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/magnum.yaml b/releasenotes/notes/magnum.yaml new file mode 100644 index 0000000000..767fcfd65e --- /dev/null +++ b/releasenotes/notes/magnum.yaml @@ -0,0 +1,3 @@ +--- +magnum: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/mistral.yaml b/releasenotes/notes/mistral.yaml new file mode 100644 index 0000000000..3f70870c78 --- /dev/null +++ b/releasenotes/notes/mistral.yaml @@ -0,0 +1,3 @@ +--- +mistral: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/neutron.yaml b/releasenotes/notes/neutron.yaml new file mode 100644 index 0000000000..cca2695842 --- /dev/null +++ b/releasenotes/notes/neutron.yaml @@ -0,0 +1,3 @@ +--- +neutron: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/nova.yaml b/releasenotes/notes/nova.yaml new file mode 100644 index 0000000000..b3609a5621 --- /dev/null +++ b/releasenotes/notes/nova.yaml @@ -0,0 +1,3 @@ +--- +nova: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/octavia.yaml b/releasenotes/notes/octavia.yaml new file mode 100644 index 0000000000..445e530560 --- /dev/null +++ b/releasenotes/notes/octavia.yaml @@ -0,0 +1,3 @@ +--- +octavia: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/panko.yaml b/releasenotes/notes/panko.yaml new file mode 100644 index 0000000000..f747778d9d --- /dev/null +++ b/releasenotes/notes/panko.yaml @@ -0,0 +1,3 @@ +--- +panko: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/placement.yaml b/releasenotes/notes/placement.yaml new file mode 100644 index 0000000000..8b37ad6c84 --- /dev/null +++ b/releasenotes/notes/placement.yaml @@ -0,0 +1,3 @@ +--- +placement: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/rally.yaml b/releasenotes/notes/rally.yaml new file mode 100644 index 0000000000..8c38f0ec48 --- /dev/null +++ b/releasenotes/notes/rally.yaml @@ -0,0 +1,3 @@ +--- +rally: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/senlin.yaml b/releasenotes/notes/senlin.yaml new file mode 100644 index 0000000000..d4cec1301b --- /dev/null +++ b/releasenotes/notes/senlin.yaml @@ -0,0 +1,3 @@ +--- +senlin: + - 0.1.0 Initial Chart diff --git a/releasenotes/notes/tempest.yaml b/releasenotes/notes/tempest.yaml new file mode 100644 index 0000000000..3bcaba77f8 --- /dev/null +++ b/releasenotes/notes/tempest.yaml @@ -0,0 +1,3 @@ +--- +tempest: + - 0.1.0 Initial Chart diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 0000000000..1ec0ea4bb7 --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,42 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'openstackdocstheme', + 'reno.sphinxext', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] + + diff --git a/releasenotes/source/current.rst b/releasenotes/source/current.rst new file mode 100644 index 0000000000..156064c8ae --- /dev/null +++ b/releasenotes/source/current.rst @@ -0,0 +1,5 @@ +============================== + Current Series Release Notes +============================== + +.. release-notes:: \ No newline at end of file diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst new file mode 100644 index 0000000000..10e8f97ebc --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,21 @@ +.. + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +============================= + OpenStack-Helm Release Notes +============================= + +.. toctree:: + :maxdepth: 1 + + current \ No newline at end of file diff --git a/tox.ini b/tox.ini index 70b5d53437..5b2f2bacbc 100644 --- a/tox.ini +++ b/tox.ini @@ -36,3 +36,6 @@ commands = whitelist_externals = rm bash + +[testenv:releasenotes] +commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html diff --git a/zuul.d/project.yaml b/zuul.d/project.yaml index 44f3a14a94..32c2b95b55 100644 --- a/zuul.d/project.yaml +++ b/zuul.d/project.yaml @@ -21,6 +21,7 @@ - project: templates: - publish-openstack-docs-pti + - release-notes-jobs-python3 check: jobs: - openstack-helm-lint