release-notes

Forked from https://github.com/corneliusweig/release-notes

Generates a markdown changelog of merged pull requests since last release. It consists of sections New Features, Fixes, Updates & Refactors, and Docs updates based on the PRs being labelled with release/new-feature, release/fixes, releases/refactor and release/doc-updates respectively

The script uses the GitHub API to retrieve a list of all merged pull requests since the last release. The found pull requests are then printed as markdown changelog with their commit summary and a link to the pull request on GitHub.

The idea and original implementation of this script is due to Bálint Pató (@balopat) while working on minikube and Skaffold.

The binary expects two parameters:

1. The GitHub organization which your repository is part of.
2. The repository name.

For example:

./release-notes GoogleContainerTools skaffold

which will output

New Features:
* add github pull request template [#2894](https://github.com/googlecontainertools/skaffold/pull/2894)


Fixes:
* Add Jib-Gradle support for Kotlin buildscripts [#2914](https://github.com/googlecontainertools/skaffold/pull/2914)


Updates & Refactors:
* Add missing T.Helper() in testutil.Check* as required [#2913](https://github.com/googlecontainertools/skaffold/pull/2913)


Docs updates:
* Move buildpacks tutorial to buildpacks example README [#2908](https://github.com/googlecontainertools/skaffold/pull/2908)
...

Specify a personal Github Token if you are hitting a rate limit anonymously (see https://github.com/settings/tokens). Otherwise, set the environment variable GITHUB_TOKEN (already set when running in a Github Action)

The tag of the last release up to which PRs should be collected (one of any, patch, minor, major, or a valid semver). Defaults to 'patch'.

For example:

go get github.com/gsquared94/release-notes

Alternately,

• For Linux

curl -Lo release-notes.tar.gz https://github.com/gsquared94/release-notes/releases/download/v0.1.2/release-notes-linux-amd64.tar.gz
tar -xvf release-notes.tar.gz
mv release-notes /usr/local/bin

• For MacOS

curl -Lo release-notes.tar.gz https://github.com/gsquared94/release-notes/releases/download/v0.1.2/release-notes-darwin-amd64.tar.gz
tar -xvf release-notes.tar.gz
mv release-notes /usr/local/bin