1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-03-17 20:47:50 +02:00

docs: Add example for --release-notes flag

I added an example to the docs of the `--release-notes` flag to make the usage more clear (see #284).
The example is an realistic use case and might help others to generate their own changelog.
This commit is contained in:
Jorin Vogel 2017-09-30 22:37:11 +02:00
parent 88247da993
commit 6fb21be33c
No known key found for this signature in database
GPG Key ID: 647AFD30D56CE8CC

View File

@ -28,3 +28,10 @@ You can have a markdown file previously created with the release notes, and
pass it down to goreleaser with the `--release-notes=FILE` flag.
GoReleaser will then skip its own release notes generation,
using the contents of your file instead.
On Unix systems you can also generate the release notes in-line by using [process substitution](https://en.wikipedia.org/wiki/Process_substitution).
To list all commits since the last tag, but skip ones starting with `Merge` or `docs`, you could run this command:
```sh
goreleaser --release-notes <(git log --pretty=oneline --abbrev-commit $(git describe --tags --abbrev=0)^.. | grep -v '^[^ ]* \(Merge\|docs\)')
```