Deprecate PBR build dependency#228
Merged
SeanBryan51 merged 1 commit intomainfrom Jan 11, 2024
Merged
Conversation
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #228 +/- ##
=======================================
Coverage 82.34% 82.34%
=======================================
Files 28 28
Lines 1410 1410
=======================================
Hits 1161 1161
Misses 249 249 ☔ View full report in Codecov by Sentry. |
Collaborator
Author
Commands tested
|
Collaborator
I take it these passed without failure? |
Collaborator
Author
|
@bschroeter yes commands ran successfully. |
bschroeter
approved these changes
Jan 11, 2024
SeanBryan51
added a commit
that referenced
this pull request
Jan 12, 2024
Previously (prior to #228), we used the [PBR][PBR] package with an explicit version number in setup.cfg. This enables the 'pre-versioning' mode of managing version strings (see [features][PBR-versioning]) which raises an error if the inferred version from Git tags is greater than explicit version in setup.cfg. This prevents developers from doing an editable install via `pip install -e .` (see #129). This issue was fixed implicitly in #228 when PBR was removed from the build dependencies. This change is a feature in that it implements dynamic version strings from Git tags via [versioneer][versioneer] so that an explicit version number in setup.cfg is not required. We choose [versioneer][versioneer] so that version strings were consistent across `pip` and `conda` installations. This was not possible with other tools such as [PBR][PBR] and [setuptools_scm][setuptools_scm]. Fixes #129 [versioneer]: https://github.com/python-versioneer/python-versioneer [PBR]: https://docs.openstack.org/pbr/latest/index.html [PBR-versioning]: https://docs.openstack.org/pbr/latest/user/features.html#version [setuptools_scm]: https://setuptools-scm.readthedocs.io/en/latest/
SeanBryan51
added a commit
that referenced
this pull request
Jan 14, 2024
Previously (prior to #228), we used the [PBR][PBR] package with an explicit version number in setup.cfg. This enables the 'pre-versioning' mode of managing version strings (see [features][PBR-versioning]) which raises an error if the inferred version from Git tags is greater than explicit version in setup.cfg. This prevents developers from doing an editable install via `pip install -e .` (see #129). This issue was fixed implicitly in #228 when PBR was removed from the build dependencies. This change is a feature in that it implements dynamic version strings from Git tags via [versioneer][versioneer] so that an explicit version number in setup.cfg is not required. We choose [versioneer][versioneer] so that version strings were consistent across `pip` and `conda` installations. This was not possible with other tools such as [PBR][PBR] and [setuptools_scm][setuptools_scm]. Fixes #129 [versioneer]: https://github.com/python-versioneer/python-versioneer [PBR]: https://docs.openstack.org/pbr/latest/index.html [PBR-versioning]: https://docs.openstack.org/pbr/latest/user/features.html#version [setuptools_scm]: https://setuptools-scm.readthedocs.io/en/latest/
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PBR is removed from the build dependencies so that we can use versioneer to solve #129. This change removes the additional options provided by PBR in setup.cfg or replaces these options with the default options that come with setuptools.
Fixes #227