https://github.com/StefH/GitHubReleaseNotes
Generate Release Notes in markdown format from GitHub projects using Oktokit and LibGit2Sharp.
https://github.com/StefH/GitHubReleaseNotes
generate github libgit2sharp markdown notes oktokit release releasenotes
Last synced: 5 months ago
JSON representation
Generate Release Notes in markdown format from GitHub projects using Oktokit and LibGit2Sharp.
- Host: GitHub
- URL: https://github.com/StefH/GitHubReleaseNotes
- Owner: StefH
- License: mit
- Created: 2018-10-26T12:53:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-06T17:29:18.000Z (6 months ago)
- Last Synced: 2024-10-30T02:19:53.521Z (6 months ago)
- Topics: generate, github, libgit2sharp, markdown, notes, oktokit, release, releasenotes
- Language: C#
- Homepage:
- Size: 1.15 MB
- Stars: 23
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - StefH/GitHubReleaseNotes - Generate Release Notes in markdown format from GitHub projects using Oktokit and LibGit2Sharp. (C# #)
README
# GitHubReleaseNotes
Generate Release Notes from GitHub.
## dotnet tool
[](https://www.nuget.org/packages/GitHubReleaseNotes)
### Installation
``` cmd
dotnet tool install --global GitHubReleaseNotes
```
## WinGet
``` cmd
winget install -e --id StefHeyenrath.GitHubReleaseNotes
```
## Chocolatey
[](https://chocolatey.org/packages/GitHubReleaseNotes)
[](https://chocolatey.org/packages/GitHubReleaseNotes)
### Installation
```
choco install GitHubReleaseNotes
```
## Usage
GitHubReleaseNotes can be run inside a git repository.
```
GitHubReleaseNotes --path . --output ReleaseNotes.md --version 1.0.4.17 --language en --skip-empty-releases --exclude-labels question
```
Arguments:
- `--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](https://en.wikipedia.org/wiki/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.
- `--exclude-labels`: Exclude Issues and Pull Requests which have these labels set.
- `--exclude-labels`: To exclude issues from the generated output, provide a space separated string list from label-names you want to exclude.
- `--token`: Provide the GitHub API token as authentication for connecting to private repositories. **@**
- `--login` and `--password`: Provide the GitHub API login and password as authentication for connecting to private repositories. **@**
**@** you only can use one authentication method
## Output
The generated Release Notes ([Markdown](https://en.wikipedia.org/wiki/Markdown) formatted) will look like:
```
# 1.0.4.16 (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
```
## Copyright
### Notes
This project is based on [GitTools/GitReleaseNotes](https://github.com/GitTools/GitReleaseNotes).
### Dependencies
- [Oktokit](https://github.com/octokit/octokit.net)
- [LibGit2Sharp](https://github.com/aarnott/libgit2sharp)
- [Handlebars.Net](https://github.com/rexm/Handlebars.Net)
- [Fody](https://github.com/Fody/Fody)
- [Fody.Costura](https://github.com/Fody/Costura)