Skip to main content

Changelog generation tool

Project description

Changelog Generator - v0.10.1

image image image style tests codecov

Details

changelog-gen is a CHANGELOG generator intended to be used in conjunction with bump-my-version to generate changelogs and create release tags.

See the docs for more details.

Usage

changelog init will generate an empty changelog with changelog init if you have not been maintaining changelogs previously. If you already have a changelog file, it will be detected.

changelog generate will extract all commits matching the conventional format since the last release, detect the correct semver release, and generate the correct changelog entry. Depending on configuration, it will also tag the release.

Migrating from 0.8 to 0.9 (Conventional Commit support)

Check the discussion here for details on how to update usage to maintain legacy functionality or move over to new features.

Installation

pip install changelog-gen

or clone this repo and install with poetry.

poetry install

Contributing

This project uses pre-commit hooks, please run pre-commit install after cloning and installing dev dependencies.

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

changelog_gen-0.10.1.tar.gz (18.3 kB view hashes)

Uploaded Source

Built Distribution

changelog_gen-0.10.1-py3-none-any.whl (21.5 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