Skip to content

Commit

Permalink
chore: refine changelog generation and categorization
Browse files Browse the repository at this point in the history
- Change the changelog configuration to use `git` instead of `github`
- Update the regular expressions for `feat` and `fix` changelog categories
- Replace the `Refactor` changelog category with `Enhancements` and update its regular expression
- Add new changelog categories for `Refactor`, `Build process updates`, and `Documentation updates` with specific ordering
- Remove filters that excluded commits with messages matching certain patterns (e.g., `docs`, `CICD`, `typo`) from the changelog

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
  • Loading branch information
appleboy committed Apr 8, 2024
1 parent 5f4bce5 commit 5bd11c6
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions .goreleaser.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ changelog:
# - `github-native`: uses the GitHub release notes generation API, disables the groups feature.
#
# Defaults to `git`.
use: github
use: git

# Sorts the changelog by the commit's messages.
# Could either be asc, desc or empty
Expand All @@ -35,22 +35,22 @@ changelog:
# Default is no groups.
groups:
- title: Features
regexp: '^.*?feat(\([[:word:]]+\))??!?:.+$'
regexp: "^.*feat[(\\w)]*:+.*$"
order: 0
- title: "Bug fixes"
regexp: '^.*?fix(\([[:word:]]+\))??!?:.+$'
regexp: "^.*fix[(\\w)]*:+.*$"
order: 1
- title: "Refactor"
regexp: '^.*?refactor(\([[:word:]]+\))??!?:.+$'
- 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 5bd11c6

Please sign in to comment.