Update CHANGELOG.md

.github/workflows/release-changelog.yaml

@@ -0,0 +1,41 @@
+name: Update changelog for release
+
+on:
+  release:
+    types: [ created ]
+
+permissions:
+  contents: write
+
+jobs:
+  update-release-changelog:
+    if: startsWith(github.ref, 'refs/tags/v')
+    name: Generate changelog
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # To use `git describe --tags`
+
+      - name: Setup Task
+        uses: arduino/setup-task@v2
+
+      - name: Check or create branch
+        run: task check_changelog_branch
+
+      - name: Generate changelog
+        uses: orhun/git-cliff-action@v3
+        with:
+          config: cliff.toml
+          args: --verbose
+        env:
+          OUTPUT: CHANGELOG.md
+
+      - name: Commit Changelog
+        run : |
+          git config --global user.name 'github-actions' 
+          git config --global user.email '[email protected]'
+          git add CHANGELOG.md
+          git commit -m "Update CHANGELOG.md"
+          git push https://github.com/${{ github.repository }}.git HEAD:update-changelog

.github/workflows/release.yaml

@@ -4,9 +4,6 @@ on:
   create:
     tags:
       - v*
-  pull_request:
-    branches:
-      - "main"
 
 permissions:
   contents: write

.github/workflows/update-changelog.yaml

@@ -0,0 +1,45 @@
+name: Update changelog for unreleased commits
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+    branches:
+      - "main"
+
+permissions:
+  contents: write
+
+jobs:
+  update-changelog:
+    name: Generate changelog
+    if: ${{ github.ref == 'refs/heads/main' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # To use `git describe --tags`
+
+      - name: Setup Task
+        uses: arduino/setup-task@v2
+
+      - name: Check or create branch
+        run: task check_changelog_branch
+
+      - name: Generate changelog
+        uses: orhun/git-cliff-action@v3
+        with:
+          config: cliff.toml
+          args: --verbose
+        env:
+          OUTPUT: CHANGELOG.md
+
+      - name: Commit Changelog
+        run : |
+          git config --global user.name 'github-actions' 
+          git config --global user.email '[email protected]'
+          git add CHANGELOG.md
+          git commit -m "Update CHANGELOG.md"
+          git push https://github.com/${{ github.repository }}.git HEAD:update-changelog

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### 🚀 Features
+
+- *(ci)* Add autochangelog (#18)
+
+### 🐛 Bug Fixes
+
+- *(ci)* Fix workflow for generating changelog (#19)
+- *(ci)* Fix workflow for generating changelog (#21)
+- *(ci)* Fix auto changelog generation (#22)
+- *(ci)* Fix auto changelog generation (#23)
+
+<!-- generated by git-cliff -->

Taskfile.yml

@@ -78,4 +78,8 @@ tasks:
     cmds:
       - |
         rm -rf ./result
-
+  check_changelog_branch:
+    desc: 'Check for a changelog branch'
+    cmds:
+      - |
+        if git ls-remote origin update-changelog | grep -sw "update-changelog" 2>&1>/dev/null; then git checkout origin/update-changelog ; else git checkout -b update-changelog ; fi

cliff.toml

@@ -0,0 +1,83 @@
+# 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]
+# template for the 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 %}\
+    ## [{{ 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 | 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 = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing s
+trim = true
+# postprocessors
+postprocessors = [
+  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
+]
+# render body even when there are no releases to process
+# render_always = true
+# output file path
+# output = "test.md"
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  # Replace issue numbers
+  #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
+  # Check spelling of the commit with https://github.com/crate-ci/typos
+  # If the spelling is incorrect, it will be automatically fixed.
+  #{ pattern = '.*', replace_command = 'typos --write-changes -' },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->🚀 Features" },
+  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
+  { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
+  { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
+  { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
+  { message = "^style", group = "<!-- 5 -->🎨 Styling" },
+  { message = "^test", group = "<!-- 6 -->🧪 Testing" },
+  { 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" },
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"