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
This commit is contained in:
Gage Hugo 2021-01-06 16:22:46 -06:00
parent cdabba7e21
commit 6ea15a7f9d
27 changed files with 164 additions and 0 deletions

View File

@ -5,3 +5,4 @@
sphinx>=2.0.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-blockdiag>=1.1.0 sphinxcontrib-blockdiag>=1.1.0
openstackdocstheme>=2.2.1 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0

31
releasenotes/config.yaml Normal file
View File

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

View File

@ -0,0 +1,3 @@
---
aodh:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
barbican:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
ceilometer:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
cinder:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
designate:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
glance:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
heat:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
horizon:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
ironic:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
keystone:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
magnum:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
mistral:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
neutron:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
nova:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
octavia:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
panko:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
placement:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
rally:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
senlin:
- 0.1.0 Initial Chart

View File

@ -0,0 +1,3 @@
---
tempest:
- 0.1.0 Initial Chart

View File

@ -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/']

View File

@ -0,0 +1,5 @@
==============================
Current Series Release Notes
==============================
.. release-notes::

View File

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

View File

@ -36,3 +36,6 @@ commands =
whitelist_externals = whitelist_externals =
rm rm
bash bash
[testenv:releasenotes]
commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html

View File

@ -21,6 +21,7 @@
- project: - project:
templates: templates:
- publish-openstack-docs-pti - publish-openstack-docs-pti
- release-notes-jobs-python3
check: check:
jobs: jobs:
- openstack-helm-lint - openstack-helm-lint