dotnet core console app that generates release notes from pull requests for the UWP Community Toolkit
Перейти к файлу
Nikola Metulev 27be88328a
Merge pull request #1 from windows-toolkit/mhawker/tag-update
Update Tags
2019-11-14 17:56:29 +01:00
ReleaseNotes Update Tags 2019-11-12 18:24:18 -08:00
.gitattributes added project 2017-08-27 18:25:58 -07:00
.gitignore added project 2017-08-27 18:25:58 -07:00
LICENSE Initial commit 2017-08-27 18:10:40 -07:00
README.md Update README.md 2017-08-27 18:48:43 -07:00
ReleaseNotes.sln added project 2017-08-27 18:25:58 -07:00

README.md

ReleaseNotesGenerator

dotnet core console application to generate release notes from Pull Requests for the UWP Community Toolkit.

Download binaries from here: https://github.com/nmetulev/ReleaseNotesGenerator/releases/tag/v1.0

Usage:

ReleaseNotes.exe [REPO-OWNER] [REPO-NAME] > [filename]

  • it will generate Markdown Release Notes by using Pull Requests. It will try to group Pull Requests based on their labels in one of these labels: "animations", "controls", "extensions", "services", "helpers", "connectivity", "notifications", "documentation", "sample app"

    Here is an example of what each line look like:

    • fix(InAppNotifications): use timer to detect notification dismiss event after timeout - David Bottiau (PR)

"ReleaseNotes.exe -auth"

  • to generate an auth token that allows higher rate of api calls with the github api. On succesful auth, a new file called token will be generated that will contain the access token that will be used for all api calls

Github API key

To enable authentication in your own build, you will need to create a new github app and add add the generated clientId and clientsecret to Program.cs