From 3495e91853c86b1b317c875d1952c76b8230bba5 Mon Sep 17 00:00:00 2001
From: jay-dee7 <jasdeepsingh.uppal@gmail.com>
Date: Tue, 14 Sep 2021 07:58:13 +0530
Subject: [PATCH] doc: added git-cliff for easy changelog generation

git-cliff uses a config.toml file present at the root directory of the
project and generates a changelog as follows:
```git cliff -vv -u -o CHANGELOG.md```

Signed-off-by: jay-dee7 <jasdeepsingh.uppal@gmail.com>
---
 cliff.toml | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 cliff.toml

diff --git a/cliff.toml b/cliff.toml
new file mode 100644
index 00000000..120511d4
--- /dev/null
+++ b/cliff.toml
@@ -0,0 +1,58 @@
+# configuration file for git-cliff (0.1.0)
+
+[changelog]
+# changelog header
+header = """
+# Changelog
+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 | replace(from="v", to="") }}] - {{ 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 %}
+        - {{ commit.message | upper_first }}\
+    {% endfor %}
+{% 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 = false
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^feat*", group = "Features"},
+    { message = "^add*", group = "Features"},
+    { message = "^impl*", group = "Features"},
+    { message = "^fix*", group = "Bug Fixes"},
+    { message = "^doc*", group = "Documentation"},
+    { message = "^perf*", group = "Performance"},
+    { message = "^refactor*", group = "Refactor"},
+    { message = "^change*", group = "Refactor"},
+    { message = "^remove*", group = "Refactor"},
+    { message = "^style*", group = "Styling"},
+    { message = "^test*", group = "Testing"},
+    { message = "^upgrade*", group = "Security"},
+    { message = "^chore\\(release\\): prepare for*", skip = true},
+    { message = "^chore*", group = "Miscellaneous Tasks"},
+    { body = ".*security", group = "Security"},
+]
+# 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"