fix(CI): use git-cliff to generate release notes

.github/workflows/release.yml

@@ -177,33 +177,42 @@ jobs:
     needs: [ docker-manifest, dl-bins ]
     permissions: write-all
     steps:
+      - uses: actions/checkout@v3
+        with:
+          lfs: true
+          fetch-depth: 0
+      - uses: orhun/git-cliff-action@v2
+        with:
+          config: cliff.toml
+          args: -vl
+        env:
+          OUTPUT: ${{github.ref_name}}-CHANGELOG.md
       - uses: actions/download-artifact@v3
-      - run: ls -R
+      - run: ls uniond-aarch64-linux
       # NOTE: please ensure that the following two steps remain in sync, other than the 
       # if condition, the `prerelease` value, and the name.
       - if: "contains(github.ref_name, 'rc')"
         name: 'Create Release Candidate'
-        uses: marvinpinto/action-automatic-releases@v1.2.1
+        uses: softprops/action-gh-release@v1
         with:
-          repo_token: '${{secrets.GITHUB_TOKEN}}'
           prerelease: true
-          automatic_release_tag: ${{github.ref_name}}
-          title: ${{github.ref_name}}
+          tag_name: ${{github.ref_name}}
+          fail_on_unmatched_files: true
           files: |
-            uniond-aarch64-linux
-            uniond-x86_64-linux
-            unionpd-aarch64-linux
-            unionpd-x86_64-linux
+            **/uniond-aarch64-linux
+            **/uniond-x86_64-linux
+            **/unionpd-aarch64-linux
+            **/unionpd-x86_64-linux
       - if: "!contains(github.ref_name, 'rc')"
         name: 'Create Release'
-        uses: marvinpinto/action-automatic-releases@v1.2.1
+        uses: softprops/action-gh-release@v1
         with:
-          repo_token: '${{secrets.GITHUB_TOKEN}}'
           prerelease: false
-          automatic_release_tag: ${{github.ref_name}}
-          title: ${{github.ref_name}}
+          tag_name: ${{github.ref_name}}
+          body_path: ${{github.ref_name}}-CHANGELOG.md
+          fail_on_unmatched_files: true
           files: |
-            uniond-aarch64-linux
-            uniond-x86_64-linux
-            unionpd-aarch64-linux
-            unionpd-x86_64-linux
+            **/uniond-aarch64-linux
+            **/uniond-x86_64-linux
+            **/unionpd-aarch64-linux
+            **/unionpd-x86_64-linux

cliff.toml

@@ -0,0 +1,85 @@
+# configuration file for git-cliff (0.1.0)
+
+[changelog]
+# changelog header
+header = """
+# Changelog\n
+"""
+# template for the changelog body
+# https://tera.netlify.app/docs/#introduction
+body = """
+{% if version %}\
+    ## {{ version }} - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits
+    | filter(attribute="scope")
+    | sort(attribute="scope") %}
+        - *({{commit.scope}})* {{ commit.message }}
+        {%- if commit.breaking %}
+        {% raw %}  {% endraw %}- **BREAKING**: *({{commit.scope}})* {{commit.breaking_description}}
+        {%- endif -%}
+    {%- endfor -%}
+    {%- for commit in commits %}
+        {%- if commit.scope -%}
+        {% else -%}
+            - {{ commit.message }}
+            {% if commit.breaking -%}
+            {% raw %}  {% endraw %}- **BREAKING**: {{commit.breaking_description}}
+            {% endif -%}
+        {% endif -%}
+    {% endfor -%}
+    {% raw %}\n{% endraw %}\
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespace from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+    { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/unionfi/union/issues/${2}))"},
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^feat", group = "Features"},
+    { message = "^fix", group = "Bug Fixes"},
+    { message = "^doc", group = "Documentation"},
+    { message = "^perf", group = "Performance"},
+    { message = "^refactor", group = "Refactor"},
+    { message = "^style", group = "Styling"},
+    { message = "^test", group = "Testing"},
+    { message = "^chore\\(release\\): prepare for", skip = true},
+    { message = "^chore", group = "Miscellaneous Tasks"},
+    { message = "^ci", group = "CI/CD"},
+    { body = ".*security", group = "Security"},
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = true
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# glob pattern for matching git tags
+tag_pattern = "v[0-9]\\.[0-9]\\.[0-9]"
+# regex for skipping tags
+skip_tags = ""
+# regex for ignoring tags
+ignore_tags = "v[0-9]\\.[0-9]\\.[0-9]-rc[0-9]"
+# sort the tags chronologically
+date_order = true
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"
+# limit the number of commits included in the changelog.
+# limit_commits = 42

dictionary.txt

@@ -176,6 +176,8 @@ dyld
 dylib
 elems
 emptively
+endfor
+endraw
 errorsmod
 esac
 ethabi
@@ -357,6 +359,7 @@ posthandler
 precommit
 prehash
 preimage
+preprocessors
 prevote
 println
 privval