changelog-generator 0.3.2

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

CHANGELOG generator

Generate CHANGELOG from git commit history

Pypi Module

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

Usage

Navigate to the repository and run:

pip install changelog-generator

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

Pre-Commit

Install pre-commit to run flake8 and isort for linting and sphinx for documentation generator.

pip install --no-cache --upgrade sphinx pre-commit recommonmark

pre-commit run --all-files

Runbook

GitHub Docs

License & copyright

© Vignesh Sivanandha Rao, Changelog Generator

Licensed under the MIT License