Support for PEP621¶
PEP621 establishes a
[project] definition inside
[project] name = "spam" version = "2.5.1"
Commitizen provides a
pep621 version provider to get and set version from this field.
You just need to set the proper
[project] name = "spam" version = "2.5.1" [tool.commitizen] version_provider = "pep621"
chore valid types in the check pattern of cz conventional_commits but not types we can select?¶
chore are added to the "pattern" in
cz check in order to prevent backward errors, but officially they are not part of conventional commits, we are using the latest types from Angular (they used to but were removed).
However, you can create a customized
cz with those extra types. (See Customization).
How to revert a bump?¶
If for any reason, the created tag and changelog were to be undone, this is the snippet:
git tag --delete <created_tag> git reset HEAD~ git reset --hard HEAD
This will remove the last tag created, plus the commit containing the update to
.cz.toml and the changelog generated for the version.
In case the commit was pushed to the server you can remove it by running
git push --delete origin <created_tag>
Is this project affiliated with the Commitizen JS project?¶
It is not affiliated.
Both are used for similar purposes, parsing commits, generating changelog and version we presume. This one is written in python to make integration easier for python projects and the other serves the JS packages.
They differ a bit in design, not sure if cz-js does any of this, but these are some of the stuff you can do with this repo (python's commitizen):
- create custom rules, version bumps and changelog generation, by default we use the popular conventional commits (I think cz-js allows this).
- single package, install one thing and it will work (cz-js is a monorepo, but you have to install different dependencies AFAIK)
- pre-commit integration
- works on any language project, as long as you create the
Where do they cross paths?
If you are using conventional commits in your git history, then you could swap one with the other in theory.
Regarding the name, cz-js came first, they used the word commitizen first. When this project was created originally, the creator read "be a good commitizen", and thought it was just a cool word that made sense, and this would be a package that helps you be a good "commit citizen".
How to handle revert commits?¶
git revert --no-commit <SHA> git commit -m "revert: foo bar"
Exception [WinError 995] The I/O operation ... error¶
This error was caused by a Python bug on Windows. It's been fixed by this PR, and according to Python's changelog, 3.8.6rc1 and 3.9.0rc2 should be the accurate versions first contain this fix. In conclusion, upgrade your Python version might solve this issue.
More discussion can be found in issue #318.
Why does commitizen not support CalVer?¶
commitizen could support CalVer alongside SemVer, but in practice implementing CalVer
creates numerous edge cases that are difficult to maintain (#385) and more generally
mixing the two version schemes may not be a good idea. If CalVer or other custom
versioning scheme is needed,
commitizen could still be used to standardize commits
and create changelogs, but a separate package should be used for version increments.
Mixing CalVer and SemVer is generally not recommended because each versioning scheme serves a different purposes. Diverging from either specification can be confusing to users and cause errors with third party tools that don't expect the non-standard format.
In the future,
commitizen may support some implementation of CalVer, but at the time
of writing, there are no plans to implement the feature (#173).
If you would like to learn more about both schemes, there are plenty of good resources: