From 634391185ce9f58f4f9ce4bf2c5880dfba5b9356 Mon Sep 17 00:00:00 2001 From: Ian Wienand Date: Mon, 14 Mar 2016 14:29:28 +1100 Subject: [PATCH] Add releasenotes Use reno to start at keeping release notes. Add an initial log. Change-Id: Iba3ebd3b01c15030ac2585dda82e43657e511310 --- .../start-using-reno-446b3d52a467a273.yaml | 19 ++ releasenotes/source/conf.py | 237 ++++++++++++++++++ releasenotes/source/index.rst | 5 + test-requirements.txt | 3 + tox.ini | 3 + 5 files changed, 267 insertions(+) create mode 100644 releasenotes/notes/start-using-reno-446b3d52a467a273.yaml create mode 100644 releasenotes/source/conf.py create mode 100644 releasenotes/source/index.rst diff --git a/releasenotes/notes/start-using-reno-446b3d52a467a273.yaml b/releasenotes/notes/start-using-reno-446b3d52a467a273.yaml new file mode 100644 index 00000000..5e7f5be7 --- /dev/null +++ b/releasenotes/notes/start-using-reno-446b3d52a467a273.yaml @@ -0,0 +1,19 @@ +--- +fixes: + + - We now use ``fstrim`` rather than ``zerofree`` to reduce final + image size. This is considered current best practice. + + - Fix an occasional failure to build ``centos-minimal`` and + ``fedora-minimal`` due to suspected rpmdb failures. The main + symptom was ``dnf`` or ``yum`` thinking packages were not + installed when they were. + + - The ``debian-minimal`` element now obeys ``DIB_DEBIAN_COMPONENTS`` + for adding components. + + - Fix some issues with Gentoo, and add to supported distributions. + Testing is currently non-voting + +other: + - Start using reno for release notes diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 00000000..117ef54a --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,237 @@ +import sys +import os + +# 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'diskimage-builder' +copyright = u'2016, Diskimage-builder contributors' + +# 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. +# + +from diskimage_builder import version as dib_version +# The short X.Y version. +release = dib_version.version_info.release_string() +# The full version, including alpha/beta/rc tags. +version = dib_version.version_info.version_string() + +# 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 = 'diskimage-builderdoc' + + +# -- 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', 'diskimage-builder-releasenotes.tex', + u'diskimage-builder Documentation', + u'OpenStack', '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', 'diskimage-builder', u'diskimage-builder Release Notes', + [u'OpenStack'], 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', 'diskimage-builder', u'diskimage-builder Release Notes', + u'OpenStack', 'diskimage-builder', 'Build disk images for CI and more.', + '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 00000000..d7c5bc10 --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,5 @@ +=============================== +diskimage-builder Release Notes +=============================== + +.. release-notes:: diff --git a/test-requirements.txt b/test-requirements.txt index ca5a5376..e3a350ad 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -10,3 +10,6 @@ testrepository>=0.0.18 # Apache-2.0/BSD # Doc requirements sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0 + +# releasenotes +reno>=1.6.2 # Apache2 diff --git a/tox.ini b/tox.ini index 328a0ab4..8205d15b 100644 --- a/tox.ini +++ b/tox.ini @@ -31,6 +31,9 @@ commands = bash -c 'if [ ! -d ./.testrepository ] ; then testr init ; fi' [testenv:docs] commands = python setup.py build_sphinx +[testenv:releasenotes] +commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html + [flake8] ignore = E125,H202,H302,H803 exclude = .venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build,conf.py