diff --git a/.gitignore b/.gitignore index b2c6a899e8..083ccff5cf 100644 --- a/.gitignore +++ b/.gitignore @@ -61,3 +61,6 @@ ChangeLog # generated config file etc/magnum/magnum.conf.sample + +# Files created by releasenotes build +releasenotes/build diff --git a/doc/source/dev/reno.rst b/doc/source/dev/reno.rst new file mode 100644 index 0000000000..98bb4eb4a7 --- /dev/null +++ b/doc/source/dev/reno.rst @@ -0,0 +1,59 @@ +Release Notes +============= + +What is reno ? +-------------- + +Magnum uses `reno `_ for +providing release notes in-tree. That means that a patch can include a *reno +file* or a series can have a follow-on change containing that file explaining +what the impact is. + +A *reno file* is a YAML file written in the releasenotes/notes tree which is +generated using the reno tool this way: + +.. code-block:: bash + + $ tox -e venv -- reno new + +where usually ```` can be ``bp-`` for a +blueprint or ``bug-XXXXXX`` for a bugfix. + +Refer to the `reno documentation `_ +for the full list of sections. + + +When a release note is needed +----------------------------- + +A release note is required anytime a reno section is needed. Below are some +examples for each section. Any sections that would be blank should be left out +of the note file entirely. If no section is needed, then you know you don't +need to provide a release note :-) + +* ``upgrade`` + * The patch has an `UpgradeImpact `_ tag + * A DB change needs some deployer modification (like a migration) + * A configuration option change (deprecation, removal or modified default) + * some specific changes that have a `DocImpact `_ tag + but require further action from an deployer perspective + * any patch that requires an action from the deployer in general + +* ``security`` + * If the patch fixes a known vulnerability + +* ``features`` + * If the patch has an `APIImpact `_ tag + +* ``critical`` + * Bugfixes categorized as Critical in Launchpad *impacting users* + +* ``fixes`` + * No clear definition of such bugfixes. Hairy long-standing bugs with high + importance that have been fixed are good candidates though. + + +Three sections are left intentionally unexplained (``prelude``, ``issues`` and +``other``). Those are targeted to be filled in close to the release time for +providing details about the soon-ish release. Don't use them unless you know +exactly what you are doing. diff --git a/doc/source/index.rst b/doc/source/index.rst index a135e8c73d..257042aba8 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -83,6 +83,7 @@ Developer Info dev/tls.rst dev/mesos.rst dev/functional-test.rst + dev/reno.rst magnum-proxy.rst contributing heat-templates diff --git a/releasenotes/notes/.placeholder b/releasenotes/notes/.placeholder new file mode 100644 index 0000000000..e69de29bb2 diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder new file mode 100644 index 0000000000..e69de29bb2 diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder new file mode 100644 index 0000000000..e69de29bb2 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 0000000000..37c5e57be0 --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,262 @@ +# -*- coding: utf-8 -*- +# +# Magnum Release Notes documentation build configuration file, created by +# sphinx-quickstart on Tue Mar 29 10:17:02 2016. +# +# 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. + +import sys +import os + +# 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 = [ + 'oslosphinx', + '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'Magnum Release Notes' +copyright = u'2016, Magnum developers' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +from magnum.version import version_info as magnum_version +version = magnum_version.canonical_version_string() +# The full version, including alpha/beta/rc tags. +release = magnum_version.version_string_with_vcs() + +# 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 = 'default' + +# 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 = ['_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' + +# 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 = 'MagnumReleaseNotesdoc' + + +# -- 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', 'MagnumReleaseNotes.tex', u'Magnum Release Notes Documentation', + u'2016, Magnum 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', 'magnumreleasenotes', u'Magnum Release Notes Documentation', + [u'2016, Magnum 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', 'MagnumReleaseNotes', u'Magnum Release Notes Documentation', + u'2016, Magnum developers', 'MagnumReleaseNotes', 'One line description of project.', + '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 diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst new file mode 100644 index 0000000000..a2058b177c --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,21 @@ +.. Magnum Release Notes documentation master file, created by + sphinx-quickstart on Tue Mar 29 10:17:02 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Magnum Release Notes's documentation! +================================================ + +Contents: + +.. toctree:: + :maxdepth: 2 + + unreleased + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 0000000000..875030f9d0 --- /dev/null +++ b/releasenotes/source/unreleased.rst @@ -0,0 +1,5 @@ +============================ +Current Series Release Notes +============================ + +.. release-notes:: diff --git a/test-requirements.txt b/test-requirements.txt index a0c5eb63c4..9b97447a66 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -21,3 +21,6 @@ testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD testtools>=1.4.0 # MIT tempest-lib>=0.14.0 # Apache-2.0 + +# releasenotes +reno>=0.1.1 # Apache2 diff --git a/tox.ini b/tox.ini index ef356c35d5..b9634be321 100644 --- a/tox.ini +++ b/tox.ini @@ -10,6 +10,7 @@ install_command = pip install -U {opts} {packages} whitelist_externals = bash find + rm setenv = VIRTUAL_ENV={envdir} deps = -r{toxinidir}/requirements.txt @@ -120,7 +121,7 @@ commands = oslo-config-generator --config-file etc/magnum/magnum-config-generator.conf [flake8] -exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,tools,magnum/common/pythonk8sclient +exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,tools,magnum/common/pythonk8sclient,releasenotes [hacking] local-check-factory = magnum.hacking.checks.factory @@ -133,3 +134,12 @@ local-check-factory = magnum.hacking.checks.factory deps = pip_missing_reqs -rrequirements.txt commands=pip-missing-reqs -d --ignore-file=magnum/tests/* magnum + +[testenv:releasenotes] +# NOTE(sdague): this target does not use constraints because +# upstream infra does not yet support it. Once that's fixed, we can +# drop the install_command. +install_command = pip install -U --force-reinstall {opts} {packages} +commands = + rm -rf releasenotes/build + sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html