https://github.com/corneliusweig/release-notes
Generates release notes from merged pull request since last release
https://github.com/corneliusweig/release-notes
automation changelog changelog-generator github-api golang-application markdown release-notes
Last synced: 27 days ago
JSON representation
Generates release notes from merged pull request since last release
- Host: GitHub
- URL: https://github.com/corneliusweig/release-notes
- Owner: corneliusweig
- License: apache-2.0
- Created: 2019-09-20T18:54:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T03:16:35.000Z (about 2 years ago)
- Last Synced: 2025-04-20T00:59:39.030Z (29 days ago)
- Topics: automation, changelog, changelog-generator, github-api, golang-application, markdown, release-notes
- Language: Shell
- Homepage:
- Size: 124 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# release-notes
[](https://travis-ci.com/corneliusweig/release-notes)
[](https://github.com/corneliusweig/release-notes/blob/master/LICENSE)
[](https://goreportcard.com/report/corneliusweig/release-notes)
Generates a markdown changelog of merged pull requests since last release.
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](https://github.com/balopat)) while working on
[minikube](https://github.com/kubernetes/minikube) and
[Skaffold](https://github.com/GoogleContainerTools/skaffold).
## Examples
The binary expects two parameters:
1. The GitHub organization which your repository is part of.
2. The repository name.
For example:
```sh
./release-notes GoogleContainerTools skaffold
```
which will output
```text
Collecting pull request that were merged since the last release: v0.38.0 (2019-09-12 22:56:07 +0000 UTC)
* add github pull request template [#2894](https://github.com/googlecontainertools/skaffold/pull/2894)
* Add Jib-Gradle support for Kotlin buildscripts [#2914](https://github.com/googlecontainertools/skaffold/pull/2914)
* Add missing T.Helper() in testutil.Check* as required [#2913](https://github.com/googlecontainertools/skaffold/pull/2913)
* Move buildpacks tutorial to buildpacks example README [#2908](https://github.com/googlecontainertools/skaffold/pull/2908)
...
```
## Options
##### `--token`
Specify a personal Github Token if you are hitting a rate limit anonymously (see https://github.com/settings/tokens).
##### `--since`
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:
| |`2.3.4-alpha.1+1234`|`2.3.4-alpha.1`|`2.3.4`|`2.3.0`|`2.0.0`|
|---|---|---|---|---|---|
|`any`|true|true|true|true|true|
|`patch`|false|false|true|true|true|
|`minor`|false|false|false|true|true|
|`major`|false|false|false|false|true|
## Installation
You need Go >=1.16. Install by running:
```sh
go install github.com/corneliusweig/release-notes
```