Generate a well formatted RST/MarkDown file from git releases or commit messages
MIT License
Get GitHub's release notes or commit history and format it into reStructuredText
/Markdown
documents.
pip install gitverse
Generate release notes from releases tagged in GitHub
gitverse-release
Tries to get release notes, using GitHub API If failed, uses the commit message as notes for the associated release This feature optionally takes
GIT_TOKEN
as an environment variable if it is generated for a personal repo
git tag
command returns incorrect timestamp (when tags are created in different timezones)
git for-each-ref --sort='-creatordate' --format '%(refname:short) %(creatordate:iso8601)' refs/tags
Generate commit history from git log
gitverse-commit
debug
- Enable debug mode for logging.reverse
- Generate commit history/release notes in reverse order.-b
Gather commit notes specific to a branch. Uses Default branch
if not passed. (Only for gitverse-commit
)-f
Write the commit notes to a custom filename.-t
Title or index line for the file generated.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
https://pypi.org/project/gitverse/
https://thevickypedia.github.io/gitverse/
© Vignesh Rao, GitVerse
Licensed under the MIT License