fix: use Poetry as Commitizen version provider #215
Merged
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.
Using Poetry as the version provider source will specifically get and set the version using the
tool.poetry.version
field inpyproject.toml
, as described here.This has two advantages:
pyproject.toml
.cz bump
works when usingversion_files
instead ofversion_provider
. When bumping the version, it will replace all instances of the current version string inpyproject.toml
with the new version string. This can cause bugs when certain dependencies coincidentally have a version constraint which contains the current version string as a substring. When this happens, it results in an inconsistent state betweenpyproject.toml
andpoetry.lock
.Here is an occurrence of this bug as reported by one of our users: