Skip to content

Commit f952c06

Browse files
committed
chore: improve changelog generation and categorization
- 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 <[email protected]>
1 parent 71a48a2 commit f952c06

File tree

1 file changed

+10
-36
lines changed

1 file changed

+10
-36
lines changed

.goreleaser.yaml

+10-36
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,7 @@ builds:
77
skip: true
88

99
changelog:
10-
# Set it to true if you wish to skip the changelog generation.
11-
# This may result in an empty release notes on GitHub/GitLab/Gitea.
12-
skip: false
13-
14-
# Changelog generation implementation to use.
15-
#
16-
# Valid options are:
17-
# - `git`: uses `git log`;
18-
# - `github`: uses the compare GitHub API, appending the author login to the changelog.
19-
# - `gitlab`: uses the compare GitLab API, appending the author name and email to the changelog.
20-
# - `github-native`: uses the GitHub release notes generation API, disables the groups feature.
21-
#
22-
# Defaults to `git`.
23-
use: git
24-
25-
# Sorts the changelog by the commit's messages.
26-
# Could either be asc, desc or empty
27-
# Default is empty
28-
sort: asc
29-
30-
# Group commits messages by given regex and title.
31-
# Order value defines the order of the groups.
32-
# Proving no regex means all commits will be grouped under the default group.
33-
# Groups are disabled when using github-native, as it already groups things by itself.
34-
#
35-
# Default is no groups.
10+
use: github
3611
groups:
3712
- title: Features
3813
regexp: "^.*feat[(\\w)]*:+.*$"
@@ -43,14 +18,13 @@ changelog:
4318
- title: "Enhancements"
4419
regexp: "^.*chore[(\\w)]*:+.*$"
4520
order: 2
21+
- title: "Refactor"
22+
regexp: "^.*refactor[(\\w)]*:+.*$"
23+
order: 3
24+
- title: "Build process updates"
25+
regexp: ^.*?(build|ci)(\(.+\))??!?:.+$
26+
order: 4
27+
- title: "Documentation updates"
28+
regexp: ^.*?docs?(\(.+\))??!?:.+$
29+
order: 4
4630
- title: Others
47-
order: 999
48-
49-
filters:
50-
# Commit messages matching the regexp listed here will be removed from
51-
# the changelog
52-
# Default is empty
53-
exclude:
54-
- "^docs"
55-
- "CICD"
56-
- typo

0 commit comments

Comments
 (0)