Skip to content

Commit

Permalink
chore: improve changelog generation and categorization
Browse files Browse the repository at this point in the history
- Change the changelog generation from `git` to `github`
- Add changelog groups for "Refactor", "Build process updates", and "Documentation updates"
- Remove changelog filters that exclude commits with messages starting with "docs", containing "CICD", or "typo"

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
  • Loading branch information
appleboy committed May 1, 2024
1 parent 71a48a2 commit f952c06
Showing 1 changed file with 10 additions and 36 deletions.
46 changes: 10 additions & 36 deletions .goreleaser.yaml
Expand Up @@ -7,32 +7,7 @@ builds:
skip: true

changelog:
# Set it to true if you wish to skip the changelog generation.
# This may result in an empty release notes on GitHub/GitLab/Gitea.
skip: false

# 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: git

# 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.
use: github
groups:
- title: Features
regexp: "^.*feat[(\\w)]*:+.*$"
Expand All @@ -43,14 +18,13 @@ changelog:
- title: "Enhancements"
regexp: "^.*chore[(\\w)]*:+.*$"
order: 2
- title: "Refactor"
regexp: "^.*refactor[(\\w)]*:+.*$"
order: 3
- title: "Build process updates"
regexp: ^.*?(build|ci)(\(.+\))??!?:.+$
order: 4
- title: "Documentation updates"
regexp: ^.*?docs?(\(.+\))??!?:.+$
order: 4
- title: Others
order: 999

filters:
# Commit messages matching the regexp listed here will be removed from
# the changelog
# Default is empty
exclude:
- "^docs"
- "CICD"
- typo

0 comments on commit f952c06

Please sign in to comment.