Commitizen - Keep a Changelog-Plugin
Adds full compliance of Commitizen with Keep a Changelog v1.1.0.
Features
- Complete map of
Conventional Commits-types
to Keep a Changelog-types of changes:
feat:Addedfix:Fixedperf:Changedrefactor:Changedrevert:Removed
- Enables to replace issue numbers in the changelog by a markdown link to the
issue:
#123->[#123](https://github.com/user/repo/issues/123) - Keep a Changelog-like header for changelog file.
Installation
Using pip:
# Install
pip install cz_keep_a_changelog_plugin
# Keep it updated
pip upgrade cz_keep_a_changelog_plugin
Using uv:
# Install
uv install cz_keep_a_changelog_plugin
# Keep it updated
uv upgrade cz_keep_a_changelog_plugin
Usage
Configuration
In the project's pyproject.toml set:
...
[tool.commitizen]
name = "cz_keep_a_changelog_plugin"
Pre-Commit
To use in pre-commit, add this to your pre-commit-config.yml. Run pre-commit
autoupdate to get the latest version:
repos:
- repo: https://github.com/commitizen-tools/commitizen
rev: main
hooks:
- id: commitizen
additional_dependencies: [cz_keep_a_changelog_plugin]
stages: [commit-msg]
- id: commitizen-branch
additional_dependencies: [cz_keep_a_changelog_plugin]
stages: [pre-push]
Additional Settings
In the project's pyproject.tomlset the issue_url_template where {{issue}}
will be replaced by the issue number:
...
[tool.commitizen]
name = "cz_keep_a_changelog_plugin"
...
[tool.commitizen.cz_keep_a_changelog_plugin]
issue_url_template = "https://cola5.github.io/cz-keep-a-changelog-plugin/issues/{{issue}}"
1 maintainer
Metadata
1 maintainer
Release files for cz-keep-a-changelog-plugin 0.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cz_keep_a_changelog_plugin-0.0.5.tar.gz | 8.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cz_keep_a_changelog_plugin-0.0.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 18.8 kB
Release files / cz_keep_a_changelog_plugin-0.0.5.tar.gz
| Download URL | cz_keep_a_changelog_plugin-0.0.5.tar.gz |
|---|---|
| Size | 8.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d6e636b81ed7683a0ad2eab70ae87ad4c73354c00e28e8699905677941e50757
|
|
BLAKE2b-256 checksum How to use checksums |
eb35248933fda7a407a37982f0666b84cf6c2176ef2e7d04a51b5973f1ec8375
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / cz_keep_a_changelog_plugin-0.0.5-py3-none-any.whl
| Download URL | cz_keep_a_changelog_plugin-0.0.5-py3-none-any.whl |
|---|---|
| Size | 10.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d35ad88d52ebae03183bcb1603d82d940f80447fed7bc7a4e7fe48fad02544db
|
|
BLAKE2b-256 checksum How to use checksums |
47efd024b922e691885e5cb6c28fcda2e9a3c48e1bc3e510b32a3070c3d7703d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
