Imported Upstream version 5.1.0 upstream/5.1.0
authorJinWang An <jinwang.an@samsung.com>
Mon, 28 Dec 2020 04:46:34 +0000 (13:46 +0900)
committerJinWang An <jinwang.an@samsung.com>
Mon, 28 Dec 2020 04:46:34 +0000 (13:46 +0900)
ChangeLog
PKG-INFO
doc/source/user/packagers.rst
doc/source/user/using.rst
pbr.egg-info/PKG-INFO
pbr/packaging.py

index c431e964b89258d37f3f6c23a179f2e6aa64b6ab..a4ef7ee6e000d0de56dd2102c0351e0d1913d2f6 100644 (file)
--- 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
index 5ecf732be3a25b4017522dd829265db8f0d4dc58..8ef2d9a4ed9703a088f6a0a0f71b51919283b3a2 100644 (file)
--- 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
         ============
         
index 74af8ac1b454defd4f5b93cb538e86a59b412ed6..2e705b05b6cc0f64afc89ffd8a3a8ced521186e4 100644 (file)
@@ -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/
index 0104640c803598323a79a5bb98d3b7872673be30..2e58fee4b7171b29a5487686b54a74b0b098c86d 100644 (file)
@@ -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``
@@ -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/
index 5ecf732be3a25b4017522dd829265db8f0d4dc58..8ef2d9a4ed9703a088f6a0a0f71b51919283b3a2 100644 (file)
@@ -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
         ============
         
index d8d37372b1e3b999a733b79f997746ab2a6c3d05..77a4b226eadcd3a1abc6ab9dd6f760e6617237fa 100644 (file)
@@ -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