Skip to main content

Generate changelog from git log with convencional commits'

Project description

mkchangelog

CI/CD CI - Test
Package PyPI - Version PyPI - Downloads PyPI - Python Version
Meta linting - Ruff code style - Black types - Mypy License - MIT

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, ReStructuredText or Json
  • generate full CHANGELOG.[md,rst,json] 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] footer references

Table of Contents

Installation

pip install mkchangelog
pip install mkchangelog[colors]  # for console colorized output

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

Install pre-commit

pip install pre-commit
pre-commit install

Run tests

hatch run all:test

Linting

hatch run lint:all

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.2.0.tar.gz (17.5 kB view hashes)

Uploaded Source

Built Distribution

mkchangelog-1.2.0-py3-none-any.whl (17.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