diff options
| author | Tim Burke <tim.burke@gmail.com> | 2018-07-30 12:33:20 -0700 |
|---|---|---|
| committer | Stephen Finucane <sfinucan@redhat.com> | 2018-09-24 13:05:35 +0100 |
| commit | a34629a956e614f60932e664801393cf1200438d (patch) | |
| tree | a3fa7d5d4269dd58334da9d911b3625875e813dd /doc | |
| parent | dac6f829af0fcca3586d7e953c7020692ae700c0 (diff) | |
| download | pbr-a34629a956e614f60932e664801393cf1200438d.tar.gz | |
Add an option to skip generating RELEASENOTES.rst
This is comparable to the existing skip_authors and skip_changelog
options.
Change-Id: Icfefb20fb3c9b2e983e56f6e5440119d4dce2d3f
Co-Authored-By: Stephen Finucane <stephenfin@redhat.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/user/packagers.rst | 17 | ||||
| -rw-r--r-- | doc/source/user/using.rst | 8 |
2 files changed, 25 insertions, 0 deletions
diff --git a/doc/source/user/packagers.rst b/doc/source/user/packagers.rst index 74af8ac..2e705b0 100644 --- a/doc/source/user/packagers.rst +++ b/doc/source/user/packagers.rst @@ -103,3 +103,20 @@ skipped. Similarly setting ``SKIP_WRITE_GIT_CHANGELOG`` will cause logic around generating ``ChangeLog`` file using *git* information to be skipped. + +.. _packaging-releasenotes: + +Release Notes +------------- + +*pbr* generates a release notes file, typically called ``RELEASENOTES.rst``, +if `reno`_ is present and configured. You may wish to disable this +functionality. If that is the case setting ``SKIP_GENERATE_RENO`` + +:: + + export SKIP_GENERATE_RENO + +will disable this feature. + +.. _reno: https://docs.openstack.org/reno/latest/ diff --git a/doc/source/user/using.rst b/doc/source/user/using.rst index b5e28eb..2917e92 100644 --- a/doc/source/user/using.rst +++ b/doc/source/user/using.rst @@ -230,6 +230,13 @@ The ``pbr`` section controls *pbr*-specific options and behaviours. This can also be configured using the ``SKIP_GENERATE_AUTHORS`` environment variable, as described :ref:`here <packaging-authors-changelog>` +``skip_reno`` + If enabled, *pbr* will not generate a ``RELEASENOTES.txt`` file if `reno`_ is + present and configured. + + This can also be configured using the ``SKIP_GENERATE_RENO`` environment + variable, as described :ref:`here <packaging-releasenotes>`. + ``autodoc_tree_index_modules`` A boolean option controlling whether *pbr* should generate an index of modules using ``sphinx-apidoc``. By default, all files except ``setup.py`` @@ -489,3 +496,4 @@ this file. .. _setuptools: http://www.sphinx-doc.org/en/stable/setuptools.html .. _sphinxcontrib-apidoc: https://pypi.org/project/sphinxcontrib-apidoc/ +.. _reno: https://docs.openstack.org/reno/latest/ |