Generate Changelog

Use your commit log to make a beautiful changelog file.

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 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
• Supports of multi-authors for one commit through configurable trailers key values

Requirements

Python 3.8 or higher.

Installation

$ pip install generate-changelog

Usage

Create a default configuration file.

$ generate-changelog --generate-config

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

Generate your changelog via:

$ generate-changelog