changelog-generator 0.7

Python module to, generate well formatted commit notes from git commit history.

CHANGELOG generator

Generate CHANGELOG from git commit history

Installation

pip install changelog-generator

Usage

Regular CHANGELOG

changelog

Regular CHANGELOG in debug mode

changelog debug

CHANGELOG in reverse order

changelog reverse

Flags

• -b Gather commit notes specific to a branch. Uses Default branch if not passed
• -f Write the commit notes to a custom filename. Defaults to CHANGELOG
• -t Title or index line for the file generated. Defaults to Change Log

Sample

release_notes.rst

Linting

PreCommit will ensure linting, and the doc creation are run on every commit.

Requirement

pip install sphinx==5.1.1 pre-commit==2.20.0 recommonmark==0.7.1

Usage

pre-commit run --all-files

Pypi Package

https://pypi.org/project/changelog-generator/

Runbook

https://thevickypedia.github.io/changelog-generator/

License & copyright

© Vignesh Sivanandha Rao, Changelog Generator

Licensed under the MIT License