diff --git a/README.md b/README.md index eb0eab8..7d43002 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ [![GitHub last commit](https://img.shields.io/github/last-commit/thevickypedia/gitverse)](https://api.github.com/repos/thevickypedia/gitverse) # GitVerse +Get release notes or commit history from `GitHub` and format it into `reStructuredText`/`Markdown` files. ### Installation ```shell @@ -25,6 +26,9 @@ Generate release notes from releases tagged in GitHub ```shell 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 diff --git a/changelog.rst b/changelog.rst index a700864..b0fa957 100644 --- a/changelog.rst +++ b/changelog.rst @@ -1,6 +1,10 @@ Commit History ============== +0.3.8 (08/10/2023) +------------------ +- Get it to a better state + 0.3.7 (08/10/2023) ------------------ - Generate release notes based on version tags diff --git a/docs/README.html b/docs/README.html index f50d39f..6fde154 100644 --- a/docs/README.html +++ b/docs/README.html @@ -54,6 +54,7 @@
Get release notes or commit history from GitHub
and format it into reStructuredText
/Markdown
files.
pip install gitverse
@@ -68,6 +69,11 @@ Release Notes (Tags)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
Get release notes via git api.
+Returns release notes in the form of release version and description as key-value pairs gathered via GitHub API.
+Dict[str, List[str]]
+Run the git command.