From 68709d68b0a57ef08f4b8418f451ebb73529c0a1 Mon Sep 17 00:00:00 2001 From: Bo-Yi Wu Date: Wed, 1 May 2024 22:19:04 +0800 Subject: [PATCH] chore: refine changelog generation process - Change the changelog configuration from `git` to `github` - Update the titles for changelog groups to use double quotes instead of single quotes - Add new changelog groups for `Refactor`, `Build process updates`, and `Documentation updates` - Remove filters that exclude commits with messages matching certain patterns from the changelog Signed-off-by: Bo-Yi Wu --- .goreleaser.yaml | 52 ++++++++++++------------------------------------ 1 file changed, 13 insertions(+), 39 deletions(-) diff --git a/.goreleaser.yaml b/.goreleaser.yaml index aa5453c..0153f8a 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -1,57 +1,31 @@ project_name: queue builds: - - - # If true, skip the build. + - # If true, skip the build. # Useful for library projects. # Default is false 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)]*:+.*$" order: 0 - - title: 'Bug fixes' + - title: "Bug fixes" regexp: "^.*fix[(\\w)]*:+.*$" order: 1 - - title: 'Enhancements' + - 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