Generate changelog from git log with convencional commits'
Project description
mkchangelog
| CI/CD |  |
| Package |    |
| Meta |     |
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
typeand byscopealso - 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.
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.0.tar.gz
(17.5 kB
view hashes)
Built Distribution
Close
Hashes for mkchangelog-1.2.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0d4cf3a97e8a75411fa29b4f1f4d529652c5c20bed2ed5495d6d67aea96217e6 |
|
| MD5 | 0cfae356e0b17b0b4a1d7a84d74051c2 |
|
| BLAKE2b-256 | 8ac6fa1a666b82f0c5b01192bdc00714c780cfdb59b58065c71bcc08664e6398 |
