From: JinWang An Date: Mon, 28 Dec 2020 04:46:34 +0000 (+0900) Subject: Imported Upstream version 5.1.0 X-Git-Tag: upstream/5.1.0^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ccfabf5fd57dd11a977de61c166bd41dde689366;p=platform%2Fupstream%2Fpython3-pbr.git Imported Upstream version 5.1.0 --- diff --git a/ChangeLog b/ChangeLog index c431e96..a4ef7ee 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,6 +1,10 @@ CHANGES ======= +5.1.0 +----- + + 5.0.0 ----- @@ -13,6 +17,7 @@ CHANGES ----- * 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 diff --git a/PKG-INFO b/PKG-INFO index 5ecf732..8ef2d9a 100644 --- a/PKG-INFO +++ b/PKG-INFO @@ -1,14 +1,14 @@ 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 ============ 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 0104640..2e58fee 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 ` +``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 `. + ``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`` @@ -487,3 +494,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/ diff --git a/pbr.egg-info/PKG-INFO b/pbr.egg-info/PKG-INFO index 5ecf732..8ef2d9a 100644 --- a/pbr.egg-info/PKG-INFO +++ b/pbr.egg-info/PKG-INFO @@ -1,14 +1,14 @@ 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 ============ diff --git a/pbr/packaging.py b/pbr/packaging.py index d8d3737..77a4b22 100644 --- a/pbr/packaging.py +++ b/pbr/packaging.py @@ -577,6 +577,13 @@ class LocalSDist(sdist.sdist): 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