commitizen-tools
Add a new FAQ for describing how to handle the case that some dependency happens to have the same version as the project version
Type
- [ ] Content inaccurate
- [X] Content missing
- [ ] Typo
URL
https://commitizen-tools.github.io/commitizen/faq/
Description
Add this section https://github.com/commitizen-tools/commitizen/issues/496#issuecomment-1527563048 to the FAQ page and add some links to other parts of the documentation
According to the comment #469, setting the version_provider to "poetry" in the tool.commitizen block should be enough to change the version value in the tool.poetry, but it does not work.
The commitizen documentation is unclear. In two places it mentions that the version field is only required if one uses the commitizen provider, see:
- https://commitizen-tools.github.io/commitizen/config/#version
- https://commitizen-tools.github.io/commitizen/config/#version-providers
...but, if I use just the "poetry" version provider, then I get the following error:
poetry run cz bump --dry-run
[NO_VERSION_SPECIFIED]
Check if current version is specified in config file, like: (...)
When I add version value to the tool.commitizen block, and keep the poetry provider, then bump updates only the version field in the commitizen block.
So either the poetry provider is not working, or the documentation should be improved (or both).
Your understanding is correct. version is only for the commitizen provider. Would you mind opening a new bug ticket with more information so we can take care of it. A sample of your poetry config and a commitizen config would be really helpful to reproduce.
Regards
