Skip to main content

Commitizen plugin for better changelog generation

Project description

cz-changeup

PyPI - Version PyPI - Python Version

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)

Uploaded Source

Built Distribution

cz_changeup-0.1.2-py3-none-any.whl (3.6 kB view hashes)

Uploaded Python 3

Supported by

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