Skip to main content

Generate changelog from git log with convencional commits'

Project description

mkchangelog

PyPI - Version PyPI - Python Version


Use this CLI tool to create a changelog for a project from the git log using the conventional commits scheme.

Features:

  • show the last changes as markdown
  • generate full CHANGELOG.md file
  • compute and bump next versions (using semver)
  • group changes by type and by scope also
  • aggregate Closes XXX-XX[,YYY-YY] and Relates XXX-XX[,YYY-YY] references
  • optionally output colorized markdown to the console (install by mkchangelog[colors] and add --cli option)

Table of Contents

Installation

pip install mkchangelog

Usage

mkchangelog changes - show  changelog for last changes, using default `fix` and `feat` types only
mkchangelog changes -t all - show  changelog for last changes, using all types
mkchangelog generate -t all - generate full changelog for current and all previous versions (signed tags) on the screen
mkchangelog bump - interactive tool; compute next versions from `feat`, `fix` and `breaking_changes`, optionaly write `CHANGELOG.md`, commit and tag next version

Contributing

Run tests

hatch run all:test

License

mkchangelog is distributed under the terms of the MIT license.

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

mkchangelog-1.1.0.tar.gz (12.3 kB view hashes)

Uploaded Source

Built Distribution

mkchangelog-1.1.0-py3-none-any.whl (13.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