CHANGES
=======
+5.1.0
+-----
+
+
5.0.0
-----
-----
* Remove my\_ip from generated wsgi script
+* Add an option to skip generating RELEASENOTES.rst
* docs: Add docs for reno integration
* Skip test for testr hook being installed when testr is not available
* Fix typo in contribution instructions
Metadata-Version: 2.1
Name: pbr
-Version: 5.0.0
+Version: 5.1.0
Summary: Python Build Reasonableness
Home-page: https://docs.openstack.org/pbr/latest/
Author: OpenStack
Author-email: openstack-dev@lists.openstack.org
License: UNKNOWN
-Project-URL: Source Code, https://git.openstack.org/cgit/openstack-dev/pbr/
Project-URL: Documentation, https://docs.openstack.org/pbr/
Project-URL: Bug Tracker, https://bugs.launchpad.net/pbr/
+Project-URL: Source Code, https://git.openstack.org/cgit/openstack-dev/pbr/
Description: Introduction
============
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/
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``
.. _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/
Metadata-Version: 2.1
Name: pbr
-Version: 5.0.0
+Version: 5.1.0
Summary: Python Build Reasonableness
Home-page: https://docs.openstack.org/pbr/latest/
Author: OpenStack
Author-email: openstack-dev@lists.openstack.org
License: UNKNOWN
-Project-URL: Source Code, https://git.openstack.org/cgit/openstack-dev/pbr/
Project-URL: Documentation, https://docs.openstack.org/pbr/
Project-URL: Bug Tracker, https://bugs.launchpad.net/pbr/
+Project-URL: Source Code, https://git.openstack.org/cgit/openstack-dev/pbr/
Description: Introduction
============
if hasattr(self, '_has_reno'):
return self._has_reno
+ option_dict = self.distribution.get_option_dict('pbr')
+ should_skip = options.get_boolean_option(option_dict, 'skip_reno',
+ 'SKIP_GENERATE_RENO')
+ if should_skip:
+ self._has_reno = False
+ return False
+
try:
# versions of reno witout this module will not have the required
# feature, hence the import