Generate Release Notes from GitHub.
choco install GitHubReleaseNotes
This will use Chocolatey to install GitHubReleaseNotes into your
%path%, ready to be used for any project
GitHubReleaseNotes can be run inside a git repository.
GitHubReleaseNotes.exe --path . --output ReleaseNotes.md --version 126.96.36.199 --language en --skip-empty-releases
--path: The path from the git repository. If not supplied, the current folder is used.
--output: The location from the generated Release Notes. If not supplied, the output is written to the console.
--version: Define a custom version name for the latest release instead of the value "next".
--language: Provide the language (two letter according to ISO-639-1) which is used to format the dates. If not provided, "en" is used. It's also possible to use a value like "system", which takes the current system ui language.
--skip-empty-releases: Define this optional argument to skip writing releases which have no associated Issues or Pull Requests.
--template: Provide a custom Handlebars template instead of the default template to generate the Release Notes.
--token: Provide the GitHub API token as authentication for connecting to private repositories. @
--password: Provide the GitHub API login and password as authentication for connecting to private repositories. @
@ you only can use one authentication method
The generated Release Notes (Markdown formatted) will look like:
# 188.8.131.52 (11 September 2018) - [#202](https://github.com/StefH/GitHubReleaseNotes/pull/202) - Update logic PR contributed by [StefH](https://github.com/StefH) - [#201](https://github.com/StefH/GitHubReleaseNotes/issues/201) - Fix issue abc
This project is based on GitTools/GitReleaseNotes.