From 53938d561b8bfa17d67ca5827d3daa6d61b30888 Mon Sep 17 00:00:00 2001
From: Kieran Klukas <92754843+kcoderhtml@users.noreply.github.com>
Date: Tue, 10 Sep 2024 18:34:00 -0400
Subject: [PATCH] feat: add cliff workflow

---
 .github/workflows/cliff.yml | 30 +++++++++++++++
 cliff.toml                  | 76 +++++++++++++++++++++++++++++++++++++
 2 files changed, 106 insertions(+)
 create mode 100644 .github/workflows/cliff.yml
 create mode 100644 cliff.toml

diff --git a/.github/workflows/cliff.yml b/.github/workflows/cliff.yml
new file mode 100644
index 00000000..494b4ec2
--- /dev/null
+++ b/.github/workflows/cliff.yml
@@ -0,0 +1,30 @@
+name: Generate Changelog
+on:
+    release:
+        types: [published]
+        branches: [master]
+permissions:
+    contents: write
+env:
+    GH_TOKEN: ${{ github.token }}
+jobs:
+    generate_changelog:
+        runs-on: ubuntu-latest
+        name: Generate Changelog
+        steps:
+            - name: Check out repository
+              uses: actions/checkout@v3
+              with:
+                  fetch-depth: 0
+
+            - name: Generate a changelog
+              uses: orhun/git-cliff-action@v3
+              with:
+                  config: cliff.toml
+                  args: --verbose --latest
+              env:
+                  OUTPUT: CHANGELOG.md
+                  GITHUB_REPO: ${{ github.repository }}
+
+            - name: Add changelog to release
+              run: gh release edit ${{ github.event.release.tag_name }} -F CHANGELOG.md
diff --git a/cliff.toml b/cliff.toml
new file mode 100644
index 00000000..754b75ea
--- /dev/null
+++ b/cliff.toml
@@ -0,0 +1,76 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+# Changelog
+
+{% if version %}\
+    **Full Commit Log**: <REPO>/commits/{{ version }}\n
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+            {% if commit.breaking %}[**breaking**] {% endif %}\
+            {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+
+# remove the leading and trailing s
+trim = true
+# postprocessors
+postprocessors = [
+    { pattern = '<REPO>', replace = "https://github.com/kcoderhtml/hackatime" }, # replace repository URL
+]
+
+[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 parsing and grouping commits
+commit_parsers = [
+    { message = "^feat", group = "<!-- 0 -->🚀 Features" },
+    { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
+    { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
+    { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
+    { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
+    { message = "^style", group = "<!-- 5 -->🎨 Styling" },
+    { message = "^test", group = "<!-- 6 -->🧪 Testing" },
+    { message = "^chore\\(release\\): prepare for", skip = true },
+    { message = "^chore\\(deps.*\\)", skip = true },
+    { message = "^chore\\(pr\\)", skip = true },
+    { message = "^chore\\(pull\\)", skip = true },
+    { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
+    { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
+    { message = "^revert", group = "<!-- 9 -->◀️ Revert" },
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = false
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# regex for matching git tags
+# tag_pattern = "v[0-9].*"
+# regex for skipping tags
+# skip_tags = ""
+# 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"
+# limit the number of commits included in the changelog.
+# limit_commits = 42
\ No newline at end of file