Commitizen plugin for better changelog generation

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for kmnhan from gravatar.com kmnhan

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License
  • Author: Kimoon Han
  • Tags changelog , commitizen
  • Requires: Python >=3.9
Classifiers
Report project as malware

Project description

cz-changeup

PyPI - Python Version PyPI - Version Conda Version Ruff

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. ": "

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for kmnhan from gravatar.com kmnhan

Unverified details

These details have not been verified by PyPI
Meta
  • License: MIT License
  • Author: Kimoon Han
  • Tags changelog , commitizen
  • Requires: Python >=3.9
Classifiers

Release history Release notifications | RSS feed

This version

1.1.2

1.1.1

1.1.0

1.0.1

1.0.0

0.3.0

0.2.0

0.1.2

0.1.1

0.1.0

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.1.2.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cz_changeup-1.1.2-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file cz_changeup-1.1.2.tar.gz.

File metadata

  • Download URL: cz_changeup-1.1.2.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for cz_changeup-1.1.2.tar.gz
Algorithm Hash digest
SHA256 f3876c32b558cb6e15a9bf8b69b7de840e90a79c0f4765439f4a9f13d4e004f2
MD5 020dc0663ea1d7be28cdaffcf50e7ffc
BLAKE2b-256 1954e98511cf11c4a12268a13f28714227b510d1f166e44f5cd2fd234e9297ab

See more details on using hashes here.

Provenance

The following attestation bundles were made for cz_changeup-1.1.2.tar.gz:

Publisher: release.yml on kmnhan/cz-changeup

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cz_changeup-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: cz_changeup-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for cz_changeup-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 938a3715cfc248e824b2ac5985b94a0cd1c505d201d8d67289fd1005e8465ec3
MD5 c0b245117a02e37d520565203cd88062
BLAKE2b-256 9f38170eab7c366e42df418486172d136b209b5208f5c04d2008d1be9b27d261

See more details on using hashes here.

Provenance

The following attestation bundles were made for cz_changeup-1.1.2-py3-none-any.whl:

Publisher: release.yml on kmnhan/cz-changeup

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page