Commitizen plugin for better changelog generation
Project description
cz-changeup
This plugin is a version of Commitizen's default conventional style with a more informative changelog format.
Installation
pip install cz-changeup
Configuration
Add to your pyproject.toml
:
[tool.commitizen]
name = "cz_changeup"
The behavior of the plugin can be customized by providing the following options under tool.commitizen
:
Option | Description | Default | Example |
---|---|---|---|
changeup_repo_base_url |
The base URL for the repository. If given, adds a link to the commit for each entry in the changelog. | "" |
"https://github.com/my/repo" |
changeup_show_body |
Whether to include the commit body in the changelog. | true |
|
changeup_body_indent |
The number of spaces to indent the commit body if show_body is set to true . |
2 |
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cz_changeup-0.1.2.tar.gz
(6.1 kB
view hashes)
Built Distribution
Close
Hashes for cz_changeup-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f6314ee015115c2f4c7b9e490048695a6dc5b8e6acb97f64a39215e17b5bfa0 |
|
MD5 | 61508d85c9704ca35423f48ac06cc795 |
|
BLAKE2b-256 | 66631ce13a79e19d7d814c5aed7b2d267ed378e04d57b58461a70e600d8ac1e7 |