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 gitverse
Usage
Commit History
gitverse-commit
Release Notes (Tags)
gitverse-release
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. (Only forgitverse-commit
)-f
Write the commit notes to a custom filename.-t
Title or index line for the file generated.
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/gitverse/
Runbook
https://thevickypedia.github.io/gitverse/
License & copyright
© Vignesh Sivanandha Rao, GitVerse
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.1a0-py3-none-any.whl
(14.5 kB
view hashes)