Metadata-Version: 2.3
Name: cz-changeup
Version: 0.1.2
Summary: Commitizen plugin for better changelog generation
Project-URL: Changelog, https://github.com/kmnhan/cz-changeup/blob/main/CHANGELOG.md
Project-URL: Documentation, https://github.com/kmnhan/cz-changeup#readme
Project-URL: Issues, https://github.com/kmnhan/cz-changeup/issues
Project-URL: Source, https://github.com/kmnhan/cz-changeup
Author-email: Kimoon Han <khan@kaist.ac.kr>
License-Expression: MIT
License-File: LICENSE
Keywords: changelog,commitizen
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Requires-Dist: commitizen>=3.0.0
Description-Content-Type: text/markdown

# cz-changeup
[![PyPI - Version](https://img.shields.io/pypi/v/cz-changeup)](https://pypi.org/project/cz-changeup)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cz-changeup)](https://pypi.org/project/cz-changeup)

This plugin is a version of
[Commitizen](https://commitizen-tools.github.io/commitizen/)'s default conventional
style with a more informative changelog format.

## Installation

```bash
pip install cz-changeup
```

## Configuration

Add to your `pyproject.toml`:

```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`     |                                |
