Commitizen plugin for better changelog generation
Project description
cz-changeup
This plugin is a version of Commitizen's default conventional style that provides more flexibility in the 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 |
---|---|---|
changeup_repo_base_url |
The base URL for the repository, for instance "https://github.com/my/repo" . |
"" |
changeup_show_hash |
Whether to add a link to the commit for each entry in the changelog. If changeup_repo_base_url is provided, the hash are linked to the commit. |
true |
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 changeup_show_body is set to true . |
2 |
changeup_link_issues |
If true , tries to convert issue numbers in phrases like closes #21 to links. Only works if changeup_repo_base_url is provided. |
true |
changeup_scope_prefix |
Prefix for the scope of the change. | "**" |
changeup_scope_suffix |
Suffix for the scope of the change. | "**" |
changeup_scope_separator |
Separator between the scope and the message. | ": " |
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.2.0.tar.gz
(7.0 kB
view hashes)
Built Distribution
Close
Hashes for cz_changeup-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d71359d21dc89d6e99ab91080a3044412b91826545f0d7d2f23c75a359db06f6 |
|
MD5 | 168e62978158ddc405f18b62f9086195 |
|
BLAKE2b-256 | f967d85868c18e74a12bd8550f99f4029fe51c054ed85c76f08059760da0e6bd |