Create changelog.yml

Author: Gerome-Elassaad

.github/workflows/changelog.yml

@@ -0,0 +1,75 @@
+name: Generate Changelog
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Generate changelog
+        id: git-cliff
+        uses: orhun/git-cliff-action@v3
+        with:
+          args: "-o CHANGELOG.md"
+        env:
+          GIT_CLIFF_CONFIG: |
+            [changelog]
+            header = """
+            # Changelog\n
+            All notable changes to this project will be documented in this file.\n
+            """
+            body = """
+            {% 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 %}
+                    - {% if commit.scope %}(**{{ commit.scope }}**) {% endif %}{{ commit.message | upper_first }} ([`{{ commit.id | truncate(length=7, end="") }}`](https://github.com/${{ github.repository }}/commit/{{ commit.id }}))\
+                {% endfor %}
+            {% endfor %}\n
+            """
+            trim = true
+            footer = ""
+
+            [git]
+            conventional_commits = true
+            filter_unconventional = true
+            split_commits = false
+            commit_parsers = [
+              { message = "^feat", group = "Features" },
+              { message = "^fix", group = "Bug Fixes" },
+              { message = "^doc", group = "Documentation" },
+              { message = "^style", group = "Styling" },
+              { message = "^refactor", group = "Refactoring" },
+              { message = "^perf", group = "Performance" },
+              { message = "^test", group = "Testing" },
+              { message = "^chore\\(release\\):", skip = true },
+              { message = "^chore", group = "Miscellaneous Tasks" },
+              { body = ".*security", group = "Security" },
+            ]
+            protect_breaking_commits = false
+            filter_commits = false
+            tag_pattern = "v[0-9]*"
+            skip_tags = "v0.1.0-beta.1"
+            ignore_tags = ""
+            sort_commits = "oldest"
+
+      - name: Commit and push changelog
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "chore(release): update changelog"
+          file_pattern: "CHANGELOG.md"
+          commit_user_name: "github-actions[bot]"
+          commit_user_email: "github-actions[bot]@users.noreply.github.com"
+          commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"