Extends Conventional Commits Change Types with User-Defined Legacy Types for Commitizen
Custom Commitizen parser for user-specified legacy change types. The parser utilizes the
cz_conventional_commits pattern and extends with the tag mapping specified in the configuration file.
While old change types will appear in the "Changelog", the user will be prevented from using them in new commits. This is the reverse of the revert/chore logic from commitizen that allows use of those commit types, but won't display them in the changelog.
This customization only works when old commits use the
<change_type>: <message> format that can be parsed by commitizen. If that doesn't fit your use case, you may want to try out incremental which (I think) prepends to an existing
To use in pre-commit, add this to your
pre-commit autoupdate to get the latest version
- repo: https://github.com/commitizen-tools/commitizen
- id: commitizen
At minimum, you must have the
name = "cz_legacy" and
[tool.commitizen.cz_legacy_map] in your configuration file. The below example is for TOML, you can also utilize a YAML or JSON file.
Below is an example of the three change legacy types Chg, Fix, and New, but the user can choose any tag names and associated mapping for the Changelog
name = "cz_legacy"
# Other tool.commitizen configuration options
Chg = "Change (old)"
Fix = "Fix (old)"
New = "New (old)"
If you have any feature requests, run into any bugs, or have questions, feel free to start a discussion or open an issue on Github at https://github.com/kyleking/cz_legacy.
We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you first open a GitHub issue to discuss your idea. For resources on getting started with the code base, see the below documentation:
Code of Conduct
We follow the Contributor Covenant Code of Conduct.
Open Source Status
We try to reasonably meet most aspects of the "OpenSSF scorecard" from Open Source Insights
If you have any security issue to report, please contact the project maintainers privately. You can reach us at email@example.com.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for cz_legacy-1.0.0-py3-none-any.whl