From 48a1f12ca34f7c55f1aa7d05584c2e2e6b882613 Mon Sep 17 00:00:00 2001
From: dundargoc <gocdundar@gmail.com>
Date: Sat, 17 Feb 2024 23:44:42 +0100
Subject: [PATCH] build: enable creating changelogs with git-cliff

Introduce a target called `changelog` that will use git-cliff to create
the changelog of the latest release.

Closes https://github.com/tree-sitter/tree-sitter/issues/527.
---
 Makefile          |  5 +++-
 script/cliff.toml | 68 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 72 insertions(+), 1 deletion(-)
 create mode 100644 script/cliff.toml

diff --git a/Makefile b/Makefile
index ecc5a96d..8358cc67 100644
--- a/Makefile
+++ b/Makefile
@@ -97,4 +97,7 @@ lint:
 format:
 	cargo fmt --all
 
-.PHONY: test test_wasm lint format
+changelog:
+	git-cliff --config script/cliff.toml --output CHANGELOG.md --latest
+
+.PHONY: test test_wasm lint format changelog
diff --git a/script/cliff.toml b/script/cliff.toml
new file mode 100644
index 00000000..46fb86c8
--- /dev/null
+++ b/script/cliff.toml
@@ -0,0 +1,68 @@
+# 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 | trim_start_matches(pat="v") }}] - {{ 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%}\
+        {% if not commit.scope %}\
+            - {{ commit.message | upper_first }}
+        {% endif %}\
+    {% endfor %}\
+    {% for group, commits in commits | group_by(attribute="scope") %}\
+        {% for commit in commits %}\
+            - **{{commit.scope}}**: {{ commit.message | upper_first }}
+        {% endfor %}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespace from the template
+trim = true
+
+[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/neovim/neovim/issues/${2}))"},
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "!:", group = "Breaking"},
+    { message = "^feat", group = "Features"},
+    { message = "^fix", group = "Bug Fixes"},
+    { message = "^doc", group = "Documentation"},
+    { message = "^perf", group = "Performance"},
+    { message = "^refactor", group = "Refactor"},
+    { message = "^test", group = "Testing"},
+    { message = "^chore", group = "Miscellaneous Tasks"},
+    { message = "^build", group = "Build System"},
+    { message = "^Revert", group = "Reverted Changes"},
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = true
+# 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 chronologically
+date_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"