From fe88e8f796ce1b28f2547f8fd11f01d11293d493 Mon Sep 17 00:00:00 2001 From: Thomas Bechtold Date: Sun, 27 Jan 2019 06:35:17 +0100 Subject: [PATCH] Add job for releasenotes With changeset [1], releasenotes are added to monasca-persister. To make the release notes available, the notes can be build now with tox ("tox -e releasenotes") and the standard zuul job (release-notes-jobs-python3) was added to build and publish the notes. Also adjust elasticsearch requirement to "<3.0.0" to be inline with the global-requirements list. This fixes: Requirement for package elasticsearch excludes a version not excluded in the global list. [1] Ida11c326b3e6771b5ccf994205c55874db05bc5c Change-Id: I16268797151a6b997610c8fbded4c9eeb9265597 --- .gitignore | 1 + .zuul.yaml | 1 + lower-constraints.txt | 3 + releasenotes/source/conf.py | 229 +++++++++++++++++++++++++++++ releasenotes/source/index.rst | 10 ++ releasenotes/source/unreleased.rst | 5 + setup.cfg | 2 +- test-requirements.txt | 5 + tox.ini | 8 + 9 files changed, 263 insertions(+), 1 deletion(-) create mode 100644 releasenotes/source/conf.py create mode 100644 releasenotes/source/index.rst create mode 100644 releasenotes/source/unreleased.rst diff --git a/.gitignore b/.gitignore index ed28003e..9fea3382 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +releasenotes/build/ target/ *.classpath *.project diff --git a/.zuul.yaml b/.zuul.yaml index 50a11eaf..3ce21fef 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -7,6 +7,7 @@ - openstack-python35-jobs - openstack-python36-jobs - openstack-python37-jobs + - release-notes-jobs-python3 check: jobs: - monasca-tempest-python2-influxdb diff --git a/lower-constraints.txt b/lower-constraints.txt index a6d01762..6a47718b 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -28,6 +28,7 @@ mox3==0.20.0 msgpack-python==0.4.0 netaddr==0.7.18 netifaces==0.10.4 +openstackdocstheme==1.18.1 os-client-config==1.28.0 os-testr==1.0.0 oslo.config==5.2.0 @@ -49,11 +50,13 @@ python-mimeparse==1.6.0 python-subunit==1.0.0 pytz==2013.6 PyYAML==3.12 +reno==2.5.0 requests==2.14.2 requestsexceptions==1.2.0 rfc3986==0.3.1 six==1.10.0 smmap==0.9.0 +Sphinx===1.6.2 stestr==1.0.0 stevedore==1.20.0 tabulate==0.8.1 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 00000000..a6da4544 --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,229 @@ +# 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.6' + +# 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' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +repository_name = u'openstack/monasca-persister' +project = u'Monitoring Persister Release Notes' + +# Release notes do not need a version number in the title, they +# cover multiple releases. +version = '' +release = '' +bug_project = u'863' +bug_tag = u'' +copyright = u'2014-present, OpenStack Foundation' +author = u'OpenStack Foundation' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'openstackdocs' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +# html_static_path = [] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'MonitoringApiReleaseNotesDoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # 'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [( + master_doc, 'MonitoringPersiterReleaseNotes.tex', + u'Monitoring Persister Release Notes', [author], + 'manual' +)] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'monitoringpersisterreleasenotes', + u'Monitoring Persister Release Notes', [author], + 1) +] + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst new file mode 100644 index 00000000..21a9bd95 --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,10 @@ +================================== +Monitoring Persister Release Notes +================================== + +Contents: + +.. toctree:: + :maxdepth: 1 + + unreleased diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 00000000..cd22aabc --- /dev/null +++ b/releasenotes/source/unreleased.rst @@ -0,0 +1,5 @@ +============================== + Current Series Release Notes +============================== + +.. release-notes:: diff --git a/setup.cfg b/setup.cfg index 2e3ab531..3105584f 100644 --- a/setup.cfg +++ b/setup.cfg @@ -36,7 +36,7 @@ influxdb = cassandra = cassandra-driver!=3.6.0,>=2.1.4 # Apache-2.0 elasticsearch = - elasticsearch<=3.0.0,>=2.0.0 # Apache-2.0 + elasticsearch<3.0.0,>=2.0.0 # Apache-2.0 [pbr] autodoc_index_modules = True diff --git a/test-requirements.txt b/test-requirements.txt index 759904c7..6e75566c 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -9,3 +9,8 @@ mock>=2.0.0 # BSD oslotest>=3.2.0 # Apache-2.0 stestr>=1.0.0 # Apache-2.0 docutils>=0.11 # OSI-Approved Open Source, Public Domain + +# release notes +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +reno>=2.5.0 # Apache-2.0 +openstackdocstheme>=1.18.1 # Apache-2.0 diff --git a/tox.ini b/tox.ini index f2bcab4a..66c141c8 100644 --- a/tox.ini +++ b/tox.ini @@ -97,3 +97,11 @@ deps = .[influxdb,cassandra,elasticsearch] -r{toxinidir}/test-requirements.txt -r{toxinidir}/requirements.txt + +[testenv:releasenotes] +basepython = python3 +description = Called from CI script to test and publish the Release Notes +commands = + rm -rf releasenotes/build + sphinx-build -a -E -W -d releasenotes/build/doctrees -b html \ + releasenotes/source releasenotes/build/html