Commitizen plugin for better changelog generation
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Project description
cz-changeup
This plugin is a version of Commitizen's default conventional style that provides more flexibility in the changelog format.
Installation
With pip:
pip install cz-changeup
With conda:
conda install -c conda-forge 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_hash_breaking |
Whether to add a link to the commit also for descriptions in the breaking changes section. | true |
changeup_show_body |
Whether to include the commit body in the changelog. | true |
changeup_hide_breaking |
Whether to include the breaking changes section also in the the commit body if changeup_show_body is true. This prevents duplicate entries. |
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
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
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-1.0.1.tar.gz
(7.8 kB
view details)
Built Distribution
File details
Details for the file cz_changeup-1.0.1.tar.gz.
File metadata
- Download URL: cz_changeup-1.0.1.tar.gz
- Upload date:
- Size: 7.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f69668b2ffbe5c051422804d9d467df46f5a7256b442afc505847f6cd354b845 |
|
| MD5 | 8c50b9825764ddd69de98a7384f01663 |
|
| BLAKE2b-256 | 563f6470ac84a77d91992b941c4fd6ffca5ba6058cdf58552188bf2509f87523 |
File details
Details for the file cz_changeup-1.0.1-py3-none-any.whl.
File metadata
- Download URL: cz_changeup-1.0.1-py3-none-any.whl
- Upload date:
- Size: 5.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d659d78f54b6deec85f78ce48c62ab311a13f7fa83502cab26297062c8872f0e |
|
| MD5 | 31ebb2c3c839aff5907df03a84e23421 |
|
| BLAKE2b-256 | 2d4ebbac13b9a32057d76906476a1116b1a9a08bd98268c2a57ce579cea724cf |
