chore(changelog): update git-cliff config

Added commit parsers that will skip certain (chore) commits.
Removed useless comments and added new comments for specific settings.

Signed-off-by: Sacha Telgenhof <me@sachatelgenhof.com>

Author: stelgenhof

cliff.toml

@@ -11,7 +11,6 @@ repo = "yasumi"
 
 [changelog]
 
-# changelog header
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.
@@ -23,21 +22,19 @@ Changes related to the logic of the holidays or their providers are listed first
 followed by any architectural or technical changes.\n
 """
 
-# template for the changelog body
-# https://keats.github.io/tera/docs/#introduction
 body = """
 {% if version -%}
     ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
 {% else -%}
-    ## [Unreleased]
+    ## [unreleased]
 {% endif -%}
 
 {% for group, commits in commits | unique(attribute="message") | filter(attribute="merge_commit", value=false) | group_by(attribute="group") %}
     ### {{ group | striptags | trim | upper_first }}
     {% for commit in commits %}
-        - {% if commit.scope %}({{ commit.scope | upper_first }}) {% endif%}{{ commit.message | split(pat="\n") | first | split(pat=": ") | last | trim | upper_first }}\
-    {% endfor %}
-{% endfor %}
+        - {% if commit.scope %}({{ commit.scope | upper_first }}) {% endif%}{{ commit.message | split(pat="\n") | first | split(pat=": ") | last | trim | upper_first }}
+    {%- endfor %}
+{% endfor %}\n
 
 {%- if github -%}
 {% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
@@ -49,43 +46,73 @@ body = """
 {%- endif %}\n\n
 """
 
-# template for the changelog footer
 footer = """
+{%- macro remote_url() -%}
+  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
+{%- endmacro -%}
+
 {% for release in releases -%}
     {% if release.version -%}
         {% if release.previous.version -%}
             [{{ release.version | trim_start_matches(pat="v") }}]: \
-                https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
-                    /compare/{{ release.previous.version }}..{{ release.version }}
+                {{ self::remote_url() }}/compare/{{ release.previous.version }}..{{ release.version }}
         {% endif -%}
     {% else -%}
-        [unreleased]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
-            /compare/{{ release.previous.version }}..HEAD
+        [unreleased]: {{ self::remote_url() }}/compare/{{ release.previous.version }}..HEAD
     {% endif -%}
 {% endfor %}
 """
 
-# remove the leading and trailing whitespace from the templates
+# Remove leading and trailing whitespaces from the changelog's body.
 trim = true
 
+# An array of regex based postprocessors to modify the changelog.
+postprocessors = [
+  # Replace the placeholder `<REPO>` with a URL.
+  { pattern = '<REPO>', replace = "https://github.com/azuyalabs/yasumi" }, # replace repository URL
+]
+
 [git]
 
-# parse the commits based on https://www.conventionalcommits.org
+# Parse commits according to the conventional commits specification.
+# See https://www.conventionalcommits.org
 conventional_commits = true
 
-# filter out the commits that are not conventional
+# Exclude commits that do not match the conventional commits specification.
 filter_unconventional = true
 
-# process each line of a commit as an individual commit
+# Split commits on newlines, treating each line as an individual commit.
 split_commits = false
 
-# preprocessors for manipulating the commit messages before parsing/grouping them
+# An array of regex based parsers to modify commit messages prior to further processing.
 commit_preprocessors = [
-  { pattern = "\\(#([0-9]+)\\)", replace = "([#${1}](https://github.com/azuyalabs/yasumi/issues/${1}))"}
+  { pattern = "\\(#([0-9]+)\\)", replace = "([#${1}](<REPO>/issues/${1}))"},
+
+  # Check spelling of the commit message using https://github.com/crate-ci/typos.
+  # If the spelling is incorrect, it will be fixed automatically.
+  { pattern = '.*', replace_command = 'typos --write-changes -' }
 ]
 
-# regex for parsing and grouping commits
+# An array of regex based parsers for extracting data from the commit message.
+# Assigns commits to groups.
+# Optionally sets the commit's scope and can decide to exclude commits from further processing.
 commit_parsers = [
+  # skip commits related to composer (e.g. package updates)
+  { message = "^chore\\(composer\\)", skip = true },
+  { message = ".*dependencies", skip = true },
+
+  # skip commits related to fixes of code style issues
+  { message = "^chore\\(style\\)", skip = true },
+
+  { message = "^docs:.*copyright", skip = true },
+
+  { message = "^chore\\(changelog\\)", skip = true },
+  { message = "^chore\\(readme\\)", skip = true },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+
+  # skip merge commits
+  { message = "^[Mm]erge", skip = true },
+
   { message = "^feat", group = "<!-- 0 -->Features" },
   { message = "^fix", group = "<!-- 1 -->Fixes" },
   { message = "^refactor", group = "<!-- 2 -->Refactor" },
@@ -94,28 +121,28 @@ commit_parsers = [
   { message = "^style", group = "<!-- 5 -->Code Style" },
   { message = "^test", group = "<!-- 6 -->Testing" },
   { message = "^chore|^ci|^build", group = "<!-- 7 -->Other" },
-
-  # skip merge commits
-  { message = "^[Mm]erge", skip = true },
 ]
 
-# protect breaking changes from being skipped due to matching a skipping commit_parser
+# Prevent commits that are breaking from being excluded by commit parsers.
 protect_breaking_commits = false
 
-# filter out the commits that are not matched by commit parsers
+# Exclude commits that are not matched by any commit parser.
 filter_commits = true
 
-# regex for matching git tags
+# Regex to select git tags that represent releases.
 tag_pattern = "[0-9].*"
 
-# regex for skipping tags
+# Regex to select git tags that do not represent proper releases.
+# Takes precedence over `tag_pattern`.
+# Changes belonging to these releases will be included in the next release.
 skip_tags = "beta|alpha"
 
-# regex for ignoring tags
+# Regex to exclude git tags after applying the tag_pattern.
 ignore_tags = ""
 
-# sort the tags topologically
-topo_order = true
+# Order releases topologically instead of chronologically.
+topo_order = false
 
-# sort the commits inside sections by oldest/newest order
+# Order of commits in each group/release within the changelog.
+# Allowed values: newest, oldest
 sort_commits = "newest"