repo: use cliff for changelog

Author: passcod

CHANGELOG.md

@@ -1,6 +1,3 @@
-# Changelog
-
-## Next (YYYY-MM-DD)
 
 ## v3.0.0 (2024-04-11)
 

cliff.toml

@@ -0,0 +1,67 @@
+[changelog]
+trim = true
+header = ""
+footer = ""
+body = """
+{% if version %}\
+	## [v{{ version | trim_start_matches(pat="v") }}] ({{ timestamp | date(format="%Y-%m-%d") }})
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% raw %}\n{% endraw %}\
+
+{%- for commit in commits | sort(attribute="group") %}
+	{%- if commit.scope -%}
+	{% else -%}
+        - **{{commit.group | striptags | trim | upper_first}}:** \
+			{% if commit.breaking %} [**⚠️ breaking ⚠️**] {% endif %}\
+			{{ commit.message | upper_first }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }}))
+	{% endif -%}
+{% endfor -%}
+
+{% for scope, commits in commits | filter(attribute="group") | group_by(attribute="scope") %}
+    ### {{ scope | striptags | trim | upper_first }}
+    {% for commit in commits | sort(attribute="group") %}
+        - **{{commit.group | striptags | trim | upper_first}}:** \
+			{% if commit.breaking %} [**⚠️ breaking ⚠️**] {% endif %}\
+            {{ commit.message | upper_first }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }}))
+    {%- endfor -%}
+    {% raw %}\n{% endraw %}\
+{% endfor %}
+"""
+postprocessors = [
+  { pattern = '\$REPO', replace = "https://github.com/watchexec/clearscreen" },
+]
+
+[git]
+conventional_commits = true
+filter_unconventional = true
+split_commits = true
+protect_breaking_commits = true
+filter_commits = true
+tag_pattern = "v[0-9].*"
+sort_commits = "oldest"
+
+link_parsers = [
+	{ pattern = "#(\\d+)", href = "https://github.com/watchexec/clearscreen/issues/$1"},
+	{ pattern = "RFC(\\d+)", text = "ietf-rfc$1", href = "https://datatracker.ietf.org/doc/html/rfc$1"},
+]
+
+commit_parsers = [
+  { message = "^feat", group = "Feature" },
+  { message = "^fix", group = "Bugfix" },
+  { message = "^tweak", group = "Tweak" },
+  { message = "^doc", group = "Documentation" },
+  { message = "^perf", group = "Performance" },
+  { message = "^refactor", group = "Refactor" },
+  { message = "^(draft|wip)", group = "WIP" },
+  { message = "^style", group = "Style" },
+  { message = "^test", group = "Test" },
+  { message = "^deps", group = "Deps" },
+  { message = "^Initial [cC]ommit$", skip = true },
+  { message = "^repo", group = "Repo" },
+  { message = "^(release|merge|fmt|chore|ci)", skip = true },
+  { body = ".*breaking", group = "Breaking" },
+  { body = ".*security", group = "Security" },
+  { message = "^revert", group = "Revert" },
+]

release.toml

@@ -2,7 +2,7 @@ tag-name = "v{{version}}"
 tag-message = "release: {{version}}"
 allow-branch = ["main"]
 pre-release-commit-message = "release: {{version}}"
-pre-release-hook = ["git", "cliff", "-c", "cliff.toml", "-o", "CHANGELOG.md", "--tag", "{{version}}"]
+pre-release-hook = ["git", "cliff", "-c", "cliff.toml", "-p", "CHANGELOG.md", "--tag", "{{version}}", "-ul"]
 pre-release-replacements = [
   { file = "README.md", search = "^clearscreen = \"[0-9\\.]+\"", replace = "clearscreen = \"{{version}}\""},
   { file = "CITATION.cff", search = "^version: \"?[0-9\\.]+\"?", replace = "version: \"{{version}}\"" },