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
- generate full CHANGELOG.md file
- compute and bump next versions (using
semver) - group changes by
typeand byscopealso - aggregate
Closes XXX-XX[,YYY-YY]andRelates XXX-XX[,YYY-YY]references - optionally output colorized markdown to the console (install by
mkchangelog[colors]and add--clioption)
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.
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.1.0.tar.gz
(12.3 kB
view hashes)
Built Distribution
Close
Hashes for mkchangelog-1.1.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ff7dade1ebb79d3c415692b3f5bef06de37b7e6307bf9969d6a80f8849b666dc |
|
| MD5 | 237c835cd804dc09ead50a505bf13627 |
|
| BLAKE2b-256 | 4617748375da4c5ea1c87c869e4f2e05319b5d05040bd6f109704cc019589f50 |
