mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-03-25 21:29:14 +02:00
docs: added changelog pipe docs
Added the documentation to the new changelog pipe. Refs #284
This commit is contained in:
parent
1d7b0e072b
commit
aca23027da
@ -34,6 +34,22 @@ release:
|
||||
name_template: "{{.ProjectName}}-v{{.Version}}"
|
||||
```
|
||||
|
||||
## Customize the changelog
|
||||
|
||||
You can customize how the changelog is generated using the
|
||||
`changelog` section in the config file:
|
||||
|
||||
```yaml
|
||||
# .goreleaser.yml
|
||||
changelog:
|
||||
filters:
|
||||
# commit messages containing the words listed here will be removed from
|
||||
# the changelog
|
||||
exclude:
|
||||
- docs
|
||||
- typo
|
||||
```
|
||||
|
||||
## Custom release notes
|
||||
|
||||
You can specify a file containing your custom release notes, and
|
||||
@ -42,8 +58,10 @@ GoReleaser will then skip its own release notes generation,
|
||||
using the contents of your file instead.
|
||||
You can use Markdown to format the contents of your file.
|
||||
|
||||
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:
|
||||
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\)')
|
||||
|
Loading…
x
Reference in New Issue
Block a user