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_link_external_issues |
If true, tries to convert external issue numbers like user/repo/#123 to links. Currently only supports github links. |
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. | ": " |
1 maintainer
Metadata
1 maintainer
Release files for cz-changeup 1.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| cz_changeup-1.1.2.tar.gz | 8.5 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cz_changeup-1.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 14.1 kB
Release files / cz_changeup-1.1.2.tar.gz
| Download URL | cz_changeup-1.1.2.tar.gz |
|---|---|
| Size | 8.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f3876c32b558cb6e15a9bf8b69b7de840e90a79c0f4765439f4a9f13d4e004f2
|
|
BLAKE2b-256 checksum How to use checksums |
1954e98511cf11c4a12268a13f28714227b510d1f166e44f5cd2fd234e9297ab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 18, 2024.
Transparency logRelease files / cz_changeup-1.1.2-py3-none-any.whl
| Download URL | cz_changeup-1.1.2-py3-none-any.whl |
|---|---|
| Size | 5.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
938a3715cfc248e824b2ac5985b94a0cd1c505d201d8d67289fd1005e8465ec3
|
|
BLAKE2b-256 checksum How to use checksums |
9f38170eab7c366e42df418486172d136b209b5208f5c04d2008d1be9b27d261
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 18, 2024.
Transparency logSecurity for cz-changeup 1.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for cz_changeup-1.1.2.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 18, 2024.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
