https://github.com/nullean/release-notes
A release notes generator based on closed Github PR's and issues.
https://github.com/nullean/release-notes
Last synced: 26 days ago
JSON representation
A release notes generator based on closed Github PR's and issues.
- Host: GitHub
- URL: https://github.com/nullean/release-notes
- Owner: nullean
- License: mit
- Created: 2020-05-09T17:36:51.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-05T12:26:36.000Z (over 1 year ago)
- Last Synced: 2025-04-20T09:18:42.956Z (about 1 month ago)
- Language: F#
- Size: 65.4 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# release-notes
Generate release notes for a release based on github labels and closed issues and PR's
## Installation
Distributed as a .NET tool so install using the following
```
dotnet tool install release-notes
```
## Run
```bat
dotnet release-notes
```
You can omit `dotnet` if you install this as a global tool
```bat
USAGE: release-notes [--help] [--label ] [--token ] [--version ]
[--oldversion ] [--releaselabel ] [--uncategorizedheader ]
REPOSITORY:
Repository to use in format
OPTIONS:
--label
Map Github labels to categorizations, format , can be specified
multiple times
--token The github token to use, if the issue list is long this may be necessary, defaults to
anonymoys
--version The version that we are generating release notes for
--oldversion The previous version to generates release notes since
--releaselabel
The version label on the issues / github prs, defaults to v[VERSION]
--uncategorizedheader
The header to use in the markdown for uncategorized issues/prs
--help display this list of options.
```
#### Examples: