Adding the stub for the changelog and the configuration file for generating it in the futurekbg/change-log

2 files changed, 94 insertions, 0 deletions

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..65b1e9b
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2024-02-28
+### Highlights
+- First Public Release of Pingora 🎉
diff --git a/cliff.toml b/cliff.toml
new file mode 100644
index 0000000..43c402a
--- /dev/null
+++ b/cliff.toml
@@ -0,0 +1,87 @@
+# 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]
+# changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+  {% if previous.version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}](https://github.com/cloudflare/pingora/compare/{{ previous.version }}...{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
+  {% else %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+  {% endif %}\
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+
+### Highlights
+  - Human-written change summaries go here
+
+{% 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
+"""
+# template for the changelog footer
+footer = """
+"""
+# remove the leading and trailing whitespace
+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 = false
+
+# process each line of a commit as an individual commit
+split_commits = false
+
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  { pattern = '\n\w+(?:\-\w+)*:\s+[^\n]+', replace = "\n" },
+  { pattern = '\n+', replace = "\n  " },
+  { pattern = '\s+$', replace = "" }
+]
+
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->🚀 Features" },
+  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
+  { message = "^doc", group = "<!-- 3 -->📚 Documentation", skip = true  },
+  { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
+  { message = "^refactor", group = "<!-- 2 -->🚜 Refactor", skip = true  },
+  { message = "^style", group = "<!-- 5 -->🎨 Styling", skip = true  },
+  { message = "^test", group = "<!-- 6 -->🧪 Testing", skip = true  },
+  { 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" },
+  { message = '\S+(?:\s+\S+){6,}', group = "<!--10--> Everything Else" }
+]
+
+# 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
+tag_pattern = "[0-9].[0-9].[0-9]"
+topo_order = false
\ No newline at end of file