chore: refactor CI workflows and enhance changelog generation

Author: RafaelJohn9

.github/workflows/auto-version.yml

@@ -0,0 +1,29 @@
+name: Tests (verify-templates, Integration tests)
+
+on:
+  pull_request:
+
+jobs:
+  verify-templates:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+      - name: Run verify-templates test
+        run: cargo test --test verify_templates
+
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+      - name: Run tests
+        run: cargo test

.github/workflows/tests.yml

@@ -1,5 +1,4 @@
-# .github/workflows/release-automation.yml
-name: Release Automation
+name: Update Changelog and Documentation
 
 on:
   workflow_dispatch: # Allows manual triggering of the workflow
@@ -49,9 +48,11 @@ jobs:
       run: |
         if [[ $GITHUB_REF == refs/tags/* ]]; then
           # On tag: Generate full history
+          git-cliff --github-token ${{ secrets.GITHUB_TOKEN }}
           git-cliff --output CHANGELOG.md
         else
           # On push to main: Only unreleased changes
+          git-cliff --github-token ${{ secrets.GITHUB_TOKEN }}
           git-cliff --unreleased --prepend CHANGELOG.md
         fi
 

.github/workflows/release_automation.yml .github/workflows/update_changelog.yml.github/workflows/release_automation.yml renamed to .github/workflows/update_changelog.yml

@@ -1,29 +1,104 @@
+# git-cliff ~ configuration file
+# https://git-cliff.org/docs/configuration
+
 [changelog]
+# A Tera template to be rendered as the changelog's header.
+# See https://keats.github.io/tera/docs/#introduction
 header = """
 # Changelog\n
-All notable changes to this project will be documented in this file.\n
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n
 """
-footer = "Generated by git-cliff"
-prepend = true  # ← Key change: New sections will be added at the TOP
+# A Tera template to be rendered for each release in the changelog.
+# See https://keats.github.io/tera/docs/#introduction
 body = """
-{% if version %}
-## [{{ version }}]
-{% else %}
-## [Unreleased]
-{% endif %}
+{%- macro remote_url() -%}
+  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
+{%- endmacro -%}
+
+{% 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 %}
-- {{ commit.message | trim }} ({{ commit.id | truncate(length=7, end="") }})
+    ### {{ group | upper_first }}
+    {%- for commit in commits %}
+        - {{ commit.message | split(pat="\n") | first | upper_first | trim }}\
+            {% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}
+            {% if commit.remote.pr_number %} in \
+            [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}) \
+            {%- endif -%}
+    {% endfor %}
 {% endfor %}
+
+{%- if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
+  ## New Contributors
+{%- endif -%}
+
+{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
+  * @{{ contributor.username }} made their first contribution
+    {%- if contributor.pr_number %} in \
+      [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \
+    {%- endif %}
+{%- endfor %}\n
+"""
+# A Tera template to be rendered as the changelog's footer.
+# See https://keats.github.io/tera/docs/#introduction
+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") }}]: \
+                {{ self::remote_url() }}/compare/{{ release.previous.version }}..{{ release.version }}
+        {% endif -%}
+    {% else -%}
+        [unreleased]: {{ self::remote_url() }}/compare/{{ release.previous.version }}..HEAD
+    {% endif -%}
 {% endfor %}
+<!-- generated by git-cliff -->
 """
+# Remove leading and trailing whitespaces from the changelog's body.
+trim = true
 
 [git]
+# Parse commits according to the conventional commits specification.
+# See https://www.conventionalcommits.org
 conventional_commits = true
-tag_pattern = "v[0-9]+\\.[0-9]+\\.[0-9]+"
+# Exclude commits that do not match the conventional commits specification.
+filter_unconventional = false
+# An array of regex based parsers to modify commit messages prior to further processing.
+commit_preprocessors = [
+  # Remove issue numbers.
+  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
+]
+# 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 = [
-    # ... (keep your existing commit parsers)
+  { message = "^[a|A]dd", group = "Added" },
+  { message = "^[s|S]upport", group = "Added" },
+  { message = "^[r|R]emove", group = "Removed" },
+  { message = "^.*: add", group = "Added" },
+  { message = "^.*: support", group = "Added" },
+  { message = "^.*: remove", group = "Removed" },
+  { message = "^.*: delete", group = "Removed" },
+  { message = "^test", group = "Fixed" },
+  { message = "^fix", group = "Fixed" },
+  { message = "^.*: fix", group = "Fixed" },
+  { message = "^.*", group = "Changed" },
 ]
+# Exclude commits that are not matched by any commit parser.
 filter_commits = false
+# Order releases topologically instead of chronologically.
+topo_order = false
+# Order of commits in each group/release within the changelog.
+# Allowed values: newest, oldest
+sort_commits = "newest"