mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-10 03:47:03 +02:00
58 lines
1.7 KiB
Markdown
58 lines
1.7 KiB
Markdown
# Changelog
|
|
|
|
You can customize how the changelog is generated using the `changelog` section in the config file:
|
|
|
|
```yaml
|
|
# .goreleaser.yml
|
|
changelog:
|
|
# Set this to true if you don't want any changelog at all.
|
|
# Warning: this will also ignore any changelog files passed via `--release-notes`,
|
|
# and will render an empty changelog.
|
|
# This may result in an empty release notes on GitHub/GitLab/Gitea.
|
|
skip: true
|
|
|
|
# Changelog generation implementation to use.
|
|
#
|
|
# Valid options are:
|
|
# - `git`: uses `git log`;
|
|
# - `github`: uses the compare GitHub API, appending the author login to the changelog.
|
|
# - `gitlab`: uses the compare GitLab API, appending the author name and email to the changelog.
|
|
# - `github-native`: uses the GitHub release notes generation API, disables the groups feature.
|
|
#
|
|
# Defaults to `git`.
|
|
use: github
|
|
|
|
# Sorts the changelog by the commit's messages.
|
|
# Could either be asc, desc or empty
|
|
# Default is empty
|
|
sort: asc
|
|
|
|
# Group commits messages by given regex and title.
|
|
# Order value defines the order of the groups.
|
|
# Proving no regex means all commits will be grouped under the default group.
|
|
# Groups are disabled when using github-native, as it already groups things by itself.
|
|
#
|
|
# Default is no groups.
|
|
groups:
|
|
- title: Features
|
|
regexp: "^.*feat[(\\w)]*:+.*$"
|
|
order: 0
|
|
- title: 'Bug fixes'
|
|
regexp: "^.*fix[(\\w)]*:+.*$"
|
|
order: 1
|
|
- title: Others
|
|
order: 999
|
|
|
|
filters:
|
|
# Commit messages matching the regexp listed here will be removed from
|
|
# the changelog
|
|
# Default is empty
|
|
exclude:
|
|
- '^docs:'
|
|
- typo
|
|
- (?i)foo
|
|
```
|
|
|
|
!!! warning
|
|
Note that using the `github-native` changelog does not support `sort` and `filter`.
|