Get GitHub's release notes or commit history and format it into `reStructuredText`/`Markdown` documents.
Project description
GitVerse
Get GitHub's release notes or commit history and format it into reStructuredText
/Markdown
documents.
Installation
pip install gitverse
Usage
Release Notes (Tags)
Generate release notes from releases tagged in GitHub
gitverse-release
:bulb: Tries to get release notes, via GitHub API call. 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.
Generate commit history from git log
Commit History
gitverse-commit
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 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.