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
Install the package from PyPi:
pip install cz_legacy or from git:
pip install git+https://github.com/KyleKing/cz_legacy.git@main
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
[tool.commitizen] name = "cz_legacy" # Other tool.commitizen configuration options [tool.commitizen.cz_legacy_map] Chg = "Change (old)" Fix = "Fix (old)" New = "New (old)"
To use in pre-commit, add this to your
repos: - repo: https://github.com/commitizen-tools/commitizen rev: v2.11.1 hooks: - id: commitizen additional_dependencies: [cz_legacy] stages: [commit-msg]
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.
I couldn't find a good way of adding a few legacy change types from an old commit style to commitizen so I built a package to extend the ConventionalCommitsCz to provide custom logic. For reference, these are the default settings
Open Issues and
Milestones for current status and ./docs/CODE_TAG_SUMMARY.md for annotations in the source code.
For release history, see the ./docs/CHANGELOG.md
See the Developer Guide, Contribution Guidelines, etc
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-0.1.7-py3-none-any.whl