ci: add git-cliff integration

2 files changed, 101 insertions, 0 deletions

diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml
new file mode 100644
index 00000000..74b20dc7
--- /dev/null
+++ b/.github/workflows/changelog.yml
@@ -0,0 +1,22 @@
+name: changelog
+on: release
+
+jobs:
+  changelog-gen:
+    name: Generate changelog
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - uses: orhun/git-cliff-action@v1
+        with:
+          config: cliff.toml
+          args: -vv --latest --strip header -c .github/workflows/cliff.toml
+        env:
+          OUTPUT: CHANGELOG.md
+
+      - name: Print the changelog
+        run: cat "${{ steps.git-cliff.outputs.changelog }}"
diff --git a/.github/workflows/cliff.toml b/.github/workflows/cliff.toml
new file mode 100644
index 00000000..83c010b6
--- /dev/null
+++ b/.github/workflows/cliff.toml
@@ -0,0 +1,79 @@
+# configuration file for git-cliff (0.1.0)
+
+[changelog]
+# changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://tera.netlify.app/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}]
+{% 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 | upper_first }}
+        {%- if commit.breaking %}
+        {% raw %}  {% endraw %}- **BREAKING**: {{commit.breaking_description}}
+        {%- endif -%}
+    {%- endfor %}
+    {% for commit in commits %}
+        {%- if commit.scope -%}
+        {% else -%}
+            - {{ commit.message | upper_first }}
+            {% if commit.breaking -%}
+            {% raw %}  {% endraw %}- **BREAKING**: {{commit.breaking_description}}
+            {% endif -%}
+        {% endif -%}
+    {% endfor -%}
+    {% raw %}{% endraw %}\
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespaces from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+
+[git]
+# allow only conventional commits
+# https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^build", group = "<!-- 0 --> Packaging"},
+    { message = "^feat", group = "<!-- 1 --> Features"},
+    { message = "(^bug|^Bug|^fix)", group = "<!-- 2 --> Bugfix"},
+    { message = "^refactor", group = "<!-- 3 --> Refactor"},
+    { message = "^chore", group = "<!-- 4 --> Miscellaneous Tasks"},
+    { message = "^doc", group = "<!-- 5 --> Documentation"},
+    { message = "^revert", group = "<!-- 6 --> Revert"},
+    { message = "^perf", group = "<!-- 7 --> Performance"},
+    { message = "^test", group = "<!-- 8 --> Testing"},
+    { message = "^ci", group = "CI", skip = 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]*"
+# regex for skipping tags
+skip_tags = "v0.1.0-beta.1"
+# regex for ignoring tags
+ignore_tags = ""
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"
+
+[features]
+preserve_order = ["serde_json/preserve_order"]