Release Notes

6.0.0

Upgrade Notes

• The deprecated support for setup.py build_sphinx has been removed. This feature has been deprecated since version 4.2. Setuptools and sphinx have removed support for this command which breaks PBR’s ability to integrate with those two tools to provide this functionality. Users should switch to building sphinx docs with sphinx directly.

5.11.0

Bug Fixes

• Fix an issue where symbols that were indented would produce an incorrect version.

5.8.1

Bug Fixes

• Packages generated with the 5.8.0 release of PBR failed to incorporate pbr.json metadata files. This is now corrected. Users can rebuild packages with newer PBR if they want that missing metadata generated.

5.7.0

New Features

• PBR now includes a PEP 517 build-backend and can be used in pyproject.toml build-system configuration. Setuptools continues to be the underlying mechanism with PBR acting as a driver via PEP 517 entrypoints.

5.5.1

Other Notes

• The 2to3 conversion utility has been long discouraged in favor of writing multi-version-capable scripts. As of Setuptools 46.2.0 it’s deprecated and slated for removal from the Python 3.10 standard library. Projects which still need it are encouraged to perform conversion prior to packaging. See https://bugs.python.org/issue40360 and https://github.com/pypa/setuptools/issues/2086 for more details.

5.5.0

Other Notes

• Support to generate bdist_wininst packages has been removed. As of Python 3.8 and Setuptools 47.2 it’s deprecated in favor of just using wheels for Windows platform packaging. See https://discuss.python.org/t/deprecate-bdist-wininst/ and https://discuss.python.org/t/remove-distutils-bdist-wininst-command/ for more details.

5.4.0

New Features

• Add an option to print only the version of a package

  Example:

  $ pbr info -s pkgname
  1.2.3
  

5.2.1

Bug Fixes

• Fixes the handling of spaces in data_files globs. Please see bug 1810934 for more details.

5.2.0

Bug Fixes

• Fix error when keywords argument as a cfg list. Previously keywords were CSV_FIELDS and with these changes keywords are now MULTI_FIELDS. Refer to https://bugs.launchpad.net/pbr/+bug/1811475 for more information.

5.1.3

Bug Fixes

• Fix mapping error on values who contains a literal =. Example when setup.cfg contains content like the following project urls configuration “project_urls = Documentation = http://foo.bar/?badge=latest”. https://bugs.launchpad.net/pbr/+bug/1817592

5.1.2

Bug Fixes

• Fixes a bug where the directory names of items specified in data_files could be renamed if the source prefix glob was contained within the directory name. See bug 1810804 for details. For more information on data_files, see the distutils documentation.

• PBR now ignores --find-links in requirements files. This option is not a valid install_requires entry for setuptools and thus breaks PBR-based installs.

5.0.0

Bug Fixes

• The description-content-type was not being set correctly. It will now be correctly populated when using setuptools 39.2.0 and beyond.

4.3.0

New Features

• Subdirectories can now be included when specfifying a requirement in requirements.txt or test-requirements.txt using VCS URIs. For example:

  -e git+https://foo.com/zipball#egg=bar&subdirectory=baz

  For more information, refer to the pip documentation.

4.0.0

New Features

• Support version parsing of git tag with the v<semver> pattern (or V<semver>), in addition to <semver>.

Upgrade Notes

• Support for entry point command hooks has been removed. This feature was poorly tested, poorly documented, and broken in some environments. Support for global hooks is not affected.

Deprecation Notes

• Support for pyN-suffixed requirement files has been deprecated: environment markers should be used instead.

• testr and nose integration has been deprecated. This feature allowed pbr to dynamically configure the test runner used when running setup.py test. However, this target has fallen out of favour in both the OpenStack and broader Python ecosystem, and both testr and nose offer native setuptools commands that can be manually aliased to test on a per-project basis, if necessary. This feature will be removed in a future release.