Metadata-Version: 2.1
Name: generate_changelog
Version: 0.7.6
Summary: Generate a changelog file from a local git checkout
Home-page: https://github.com/coordt/generate_changelog
Author: Corey Oordt
Author-email: coreyoordt@gmail.com
License: MIT
Project-URL: Documentation, https://coordt.github.io/generate-changelog/
Project-URL: Source, https://github.com/coordt/generate-changelog
Keywords: changelog,change,git,commit
Classifier: Environment :: Console
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Version Control :: Git
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
License-File: LICENSE

# Generate Changelog

<!-- start badges -->
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/coordt/generate-changelog/master.svg)](https://results.pre-commit.ci/latest/github/coordt/generate-changelog/master)
[![Coverage Status](https://coveralls.io/repos/github/coordt/generate-changelog/badge.svg?branch=master)](https://coveralls.io/github/coordt/generate-changelog?branch=master)
Use your commit log to make a beautiful changelog file.
<!-- end badges -->

## Features

- Configurable to adapt to your changelog preferences.
- Filter out commits and tags based on regular expression matching.
- Classify commit messages into sections such as "New", "Fixes", and "Changes".
- Templated using [Jinja](https://jinja.palletsprojects.com/en/3.0.x/) templates.
- Rewrite commit summary or commit body using pipelines of actions.
- Supports your merge or rebase workflows and complicated git histories.
- Supports full or incremental changelog generation.
- Parses [trailers key values](https://zerokspot.com/weblog/2020/10/24/git-commit-messages-with-attributes/)
- Supports of multi-authors for one commit through configurable [trailers key values](https://git.wiki.kernel.org/index.php/CommitMessageConventions)

## Requirements

Python 3.8 or higher.

## Installation

```bash
$ pip install generate-changelog
```

## Usage

Create a default configuration file.

```bash
$ generate-changelog --generate-config
```

This creates a file named `.changelog-config.yaml`. You can make changes to the default configuration.

Generate your changelog via:

```bash
$ generate-changelog
```
