Added support for reno release notes

Change-Id: Icf04f5d8dcb4a04f567e6a3bc10760831e6b43cc

.gitignore

@@ -10,4 +10,8 @@ build/
 env/*
 cover/*
 .vscode/
-venv/
+venv/
+
+AUTHORS
+ChangeLog
+releasenotes/build

doc/source/index.rst

@@ -6,6 +6,7 @@ Welcome to Adjutant's documentation!
    :maxdepth: 1
 
    development
+   release-notes
    devstack-guide
    configuration
    plugins

doc/source/release-notes.rst

@@ -0,0 +1,99 @@
+==========================
+Working with Release Notes
+==========================
+
+The Adjutant team uses `reno
+<https://docs.openstack.org/reno/latest/user/usage.html>`_ to generate release
+notes. These are important user-facing documents that must be included when a
+user or operator facing change is performed, like a bug-fix or a new feature. A
+release note should be included in the same patch the work is being performed.
+Release notes should be short, easy to read, and easy to maintain. They also
+`must` link back to any appropriate documentation if it exists. The following
+conventions help ensure all release notes achieve those goals.
+
+Most release notes either describe bug fixes or announce support for new
+features, both of which are tracked using Launchpad. The conventions below rely
+on links in Launchpad to provide readers with more context.
+
+.. warning::
+
+    We highly recommend taking careful thought when writing and reviewing
+    release notes. Once a release note has been published with a formal
+    release, updating it across releases will cause it to be published in a
+    subsequent release. Reviews that update, or modify, a release note from a
+    previous release outside of the branch it was added in should be rejected
+    unless it's required for a very specific case.
+
+    Please refer to reno's `documentation
+    <https://docs.openstack.org/reno/latest/user/usage.html>`_ for more
+    information.
+
+Release Notes for Bugs
+======================
+
+When creating a release note that communicates a bug fix, use the story number
+in the name of the release note:
+
+.. code-block:: bash
+
+    $ tox -e venv reno new story-1652012
+    Created new notes file in releasenotes/notes/story-1652012-7c53b9702b10084d.yaml
+
+The body of the release note should clearly explain how the impact will affect
+users and operators. It should also include why the change was necessary but
+not be overspecific about implementation details, as that can be found in the
+commit and the bug report. It should contain a properly formatted link in
+reStructuredText that points back to the original bug report used to track the
+fix. This ensures the release note is kept short and to-the-point while
+providing readers with additional resources:
+
+.. code-block:: yaml
+
+    ---
+    fixes:
+      - |
+        [`bug 1652012 <https://storyboard.openstack.org/#!/story/111111>`_]
+        This bug was fixed because X and we needed to maintain a certain level
+        of backwards compatibility with the fix despite so it still defaults to
+        an unsafe value.
+    deprecations:
+      - >
+        X is now deprecated and should no longer be used. Instead use Y.
+
+
+Release Notes for Features
+==========================
+
+Release notes detailing feature work follow the same basic format, since
+features are also tracked as stories.
+
+.. code-block:: bash
+
+    $ tox -e venv reno new story-1652012
+    Created new notes file in releasenotes/notes/story-1652012-7c53b9702b10084d.yaml
+
+Just like release notes communicating bug fixes, release notes detailing
+feature work must contain a link back to the story. Readers should be able
+to easily discover all patches that implement the feature, as well as find
+links to the full specification and documentation. The release notes can be
+added to the last patch of the feature. All of this is typically found in the
+story on storyboard:
+
+.. code-block:: yaml
+
+    ---
+    features:
+      - >
+        [`story 1652012 <https://storyboard.openstack.org/#!/story/222222>`_]
+        We now support Q
+    upgrade:
+      - >
+        We highly recommend people using W to switch to using Q
+
+In the rare case there is a release note that does not pertain to a bug or
+feature work, use a sensible slug and include any documentation relating to the
+note. We can iterate on the content and application of the release note during
+the review process.
+
+For more information on how and when to create release notes, see the
+`project-team-guide <https://docs.openstack.org/project-team-guide/release-management.html#how-to-add-new-release-notes>`_.

releasenotes/source/conf.py

@@ -0,0 +1,276 @@
+# 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.
+
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+# sys.path.insert(0, os.path.abspath('.'))
+
+# -- 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'
+
+# General information about the project.
+project = u'Adjutant Release Notes'
+copyright = u'2019, Adjutant Developers'
+
+# Release  notes are version independent
+
+# The full version, including alpha/beta/rc tags.
+
+release = ''
+# The short X.Y version.
+version = ''
+
+# 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
+# "<project> v<release> 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 = ['_static']
+
+# 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 = '%b %d, %Y'
+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 <link> 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 = 'AdjutantReleaseNotesdoc'
+
+
+# -- 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 = [
+    ('index', 'AdjutantReleaseNotes.tex',
+     u'Adjutant Release Notes Documentation',
+     u'Adjutant Developers', '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 = [
+    ('index', 'adjutantreleasenotes', u'Adjutant Release Notes Documentation',
+     [u'Adjutant Developers'], 1)
+]
+
+# If true, show URL addresses after external links.
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    ('index', 'AdjutantReleaseNotes', u'Adjutant Release Notes Documentation',
+     u'Adjutant Developers', 'AdjutantReleaseNotes',
+     'An extensible API framework for admin logic in OpenStack.',
+     'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+# texinfo_no_detailmenu = False
+
+# -- Options for Internationalization output ------------------------------
+locale_dirs = ['locale/']
+
+# -- Options for openstackdocstheme -------------------------------------------
+repository_name = 'openstack/adjutant'
+bug_project = 'adjutant'
+bug_tag = 'doc'

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.
+
+======================
+Adjutant Release Notes
+======================
+
+.. toctree::
+   :maxdepth: 1
+
+   unreleased

releasenotes/source/unreleased.rst

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

test-requirements.txt

@@ -10,3 +10,4 @@ os-api-ref>=1.6.1 # Apache-2.0
 sphinx-rtd-theme>=0.4.3
 sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7'  # BSD
 sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4'  # BSD
+reno>=2.11.3 # Apache-2.0

tox.ini

@@ -47,4 +47,7 @@ commands =
 ignore = D100,D101,D102,D103,D104,D105,D200,D203,D202,D204,D205,D208,D400,D401,W503
 show-source = true
 builtins = _
-exclude=.venv,venv,.env,env,.git,.tox,dist,doc,*lib/python*,*egg,adjutant/api/migrations/*,adjutant/actions/migrations
+exclude=.venv,venv,.env,env,.git,.tox,dist,doc,*lib/python*,*egg,releasenotes,adjutant/api/migrations/*,adjutant/actions/migrations
+
+[testenv:releasenotes]
+commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html