Python module to, generate well formatted commit notes from git commit history.
Project description
CHANGELOG generator
Generate CHANGELOG from git commit history
Installation
pip install changelog-generator
Usage
Commit History
changelog
Release Notes (Tags)
releasenotes
Options
debug
- Enable debug mode for logging.reverse
- Generate commit history/release notes in reverse order.
Flags
-b
Gather commit notes specific to a branch. UsesDefault branch
if not passed-f
Write the commit notes to a custom filename. Defaults toCHANGELOG
-t
Title or index line for the file generated. Defaults toChange Log
Sample
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
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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
gitverse-0.0a0-py3-none-any.whl
(20.8 kB
view hashes)