Generate changelog from git log with convencional commits'
Project description
mkchangelog
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 byscope
also - aggregate
Closes: XXX-XX[,YYY-YY]
andRelates: 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
Release history Release notifications | RSS feed
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.1.tar.gz
(17.8 kB
view hashes)
Built Distribution
Close
Hashes for mkchangelog-1.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be9ba0d79d5823efd9c03106f5fad739ff60de7aefec1ed84fc1779e48a2f9ac |
|
MD5 | eb641d58b0f305c1d8bd5b3b31a6fee0 |
|
BLAKE2b-256 | 0c7ccf2d6f616f2f20c41addd0d9ee1ddf21fcd92cc28c06980d08af701b845d |