chore(config): adjust formatting and improve changelog parsing

.gitea/workflows/release.yml

@@ -14,6 +14,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Release
-        uses: https://git.0xmax42.io/actions/auto-changelog-release-action@v0.3.0
+        uses: https://git.0xmax42.io/actions/auto-changelog-release-action@v0
         with:
           token: ${{ secrets.RELEASE_PUBLISH_TOKEN }}
+          allow_non_main_release: "true"

CHANGELOG.md

@@ -2,6 +2,41 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.1.0](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v1.0.1..v1.1.0) - 2025-09-29
+
+### 🚀 Features
+
+- *(scripts)* Add type extraction and mismatch detection logic - ([e8426bb](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/e8426bb839dd29f807f232efe5f7bf829ec4f9f1))
+
+### 📚 Documentation
+
+- Add changelog improvement ideas to TODO file - ([f54df9f](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/f54df9fbc42e3fc453042a1f2c36f7cd12e38c41))
+
+### ⚙️ Miscellaneous Tasks
+
+- *(config)* Improve child commit handling in merge template - ([65462f5](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/65462f5a1495aa45afd727a962126db953ab75a5))
+
+## [1.0.1](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v1.0.0..v1.0.1) - 2025-09-27
+
+### ⚙️ Miscellaneous Tasks
+
+- *(scripts)* Check for existing Python installation - ([94980be](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/94980be3e5e5827b75edf9abeab0987709fa3122))
+
+## [1.0.0](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.4.3..v1.0.0) - 2025-09-27
+
+### 🚀 Features
+
+- *(ci)* [**breaking**] Enhance changelog generation with context augmentation - ([8de8b47](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/8de8b470386cf9f21cec660ba71d840ea6786231))
+
+### 🐛 Bug Fixes
+
+- *(release)* Fix changelog generation pipe usage - ([fedcc1f](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/fedcc1ff41b9535f5002d046427dd640b647bde4))
+
+### ⚙️ Miscellaneous Tasks
+
+- *(release)* Update action version in workflow - ([73a1b5c](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/73a1b5cc243248b50275b2368a4cd92bbb4a1a8e))
+- *(ci)* Allow non-main branch releases - ([121ea5b](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/121ea5b57a587626a036738c23e2983380470dd7))
+
 ## [0.4.3](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.4.2..v0.4.3) - 2025-06-29
 
 ### 🐛 Bug Fixes

TODO.md

@@ -0,0 +1,46 @@
+# TODO
+
+## Git-Cliff / Changelog Improvements
+
+### Idea: Use Merge Commit Body as Documentation
+
+* **Context**: Normally, only the commit subject is included in changelogs.
+* **Idea**: Treat merge commits as *project documentation*.
+
+  * The subject line = headline of the feature / branch.
+  * The body = narrative explanation of what the branch accomplished.
+  * Child commits = detailed steps, already included under the merge.
+
+### Benefits
+
+* Provides more context for each feature branch.
+* Turns the changelog into a lightweight project documentation.
+* Keeps individual commits small and clean while still showing the bigger picture.
+* Optional: if no body is present, nothing changes.
+
+### Possible Implementation
+
+* In the changelog template:
+
+  * Detect merge commits.
+  * Render `commit.body` below the subject line.
+  * Indent and format properly (e.g. bullet points preserved).
+
+### Example
+
+```
+### 🚀 Features
+
+- 🔀 **Merge branch 'feature/oauth2'** - ([abc1234](...))
+    Add OAuth2 login flow with full explanation of scope:
+    - why OAuth2 was chosen
+    - compatibility with existing login
+    - possible future extensions
+
+    - *(auth)* Add login endpoint - ([def5678](...))
+    - *(auth)* Implement token exchange - ([ghi9012](...))
+    - *(auth)* Add error handling - ([jkl3456](...))
+    - *(test)* Add unit tests for OAuth2 flow - ([mno7890](...))
+```
+
+---

VERSION

@@ -1 +1 @@
-0.4.3
+1.1.0

action.yml

@@ -44,6 +44,11 @@ runs:
       run: |
         ${{ github.action_path }}/scripts/install-git-cliff.sh "${{ steps.cliff_version.outputs.version }}"
 
+    - name: Install Python
+      shell: bash
+      run: |
+        ${{ github.action_path }}/scripts/install-python.sh
+
     - name: Set up git
       shell: bash
       run: |

cliff.toml

@@ -1,4 +1,4 @@
-# CLIFF_VERSION=2.8.0
+# CLIFF_VERSION=2.10.1
 # git-cliff ~ default configuration file
 # https://git-cliff.org/docs/configuration
 #
@@ -10,23 +10,27 @@ owner = "actions"
 repo = "auto-changelog-release-action"
 
 [changelog]
-# postprocessors
 postprocessors = [
     { pattern = '<GITEA_URL>', replace = "https://git.0xmax42.io" }, # replace gitea url
 ]
 
-# 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 = """
 {%- macro remote_url() -%}
   <GITEA_URL>/{{ remote.gitea.owner }}/{{ remote.gitea.repo }}
 {%- endmacro -%}
 
+{%- macro indent(text, prefix="  ") -%}
+    {%- set lines = text | split(pat="\n") -%}
+    {%- for l in lines -%}
+        {{ prefix ~ l }}{% if not loop.last %}{{ "\n" }}{% endif %}
+    {%- endfor -%}
+{%- endmacro -%}
+
 {% if version %}\
     {% if previous.version %}\
         ## [{{ version | trim_start_matches(pat="v") }}]\
@@ -38,16 +42,29 @@ body = """
     ## [unreleased]
 {% endif %}\
 {% for group, commits in commits | group_by(attribute="group") %}
-    ### {{ group | striptags | trim | upper_first }}
-    {% for commit in commits %}
+    ### {{ group | striptags | trim | upper_first }}\n
+    {% for commit in commits %}\
+        {% if commit.merge_commit %}\
+    - 🔀 **{{ commit.message | upper_first }}** - \
+    ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
+    {% if commit.body %}\n{{ self::indent(text=commit.body, prefix="  ") }}{% endif %}\
+        {% if commit.extra and commit.extra.children %}\
+            {% for child in commit.extra.children %}
+                {{ "    " | safe }}- {% if child.extra.mismatch_type %}**{{ child.extra.mismatch_type }}**:{% endif %}{% if child.scope %}*({{ child.scope }})* {% endif %}\
+                {% if child.breaking %}[**breaking**] {% endif %}\
+                {{ child.message | upper_first }} - \
+                ([{{ child.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ child.id }}))\
+            {% endfor %}\
+        {% endif %}\
+        {% else %}\
     - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
     {% if commit.breaking %}[**breaking**] {% endif %}\
     {{ commit.message | upper_first }} - \
     ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
-    {% endfor %}
+        {% endif %}
+    {% endfor %}\
 {% endfor %}\n
 """
-# template for the changelog footer
 footer = """
 
 """

scripts/augment_context.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+import json
+import subprocess
+import sys
+import re
+
+def extract_type(raw_message: str) -> str | None:
+    m = re.match(r"^(\w+)(?:\([^)]+\))?:", raw_message.strip())
+    return m.group(1) if m else None
+
+def git_commits_between(parent, merge):
+    """Return list of commit hashes between parent and merge (exclusive of parent, inclusive of merge)."""
+    out = subprocess.check_output(
+        ["git", "rev-list", f"{parent}..{merge}", "--no-merges"],
+        text=True
+    )
+    return [line.strip() for line in out.splitlines() if line.strip()]
+
+def load_context(path=None):
+    if path:
+        with open(path) as f:
+            return json.load(f)
+    else:
+        return json.load(sys.stdin)
+
+def main(path=None):
+    context = load_context(path)
+    commits = context[0]["commits"]
+    commits_by_id = {c["id"]: c for c in commits}
+
+    new_commits = []
+    consumed = set()
+
+    for c in commits:
+        if c.get("merge_commit"):
+            parents = subprocess.check_output(
+                ["git", "rev-list", "--parents", "-n", "1", c["id"]],
+                text=True
+            ).strip().split()
+            merge_id, *parent_ids = parents
+
+            parent_type = extract_type(c["raw_message"])
+
+            if len(parent_ids) >= 2:
+                mainline = parent_ids[0]
+                children_ids = git_commits_between(mainline, merge_id)
+
+                children = []
+                for cid in children_ids:
+                    if cid in commits_by_id:
+                        child = commits_by_id[cid]
+                        child_type = extract_type(child["raw_message"])
+                        if child_type and parent_type and child_type != parent_type:
+                            if not child.get("extra") or not isinstance(child["extra"], dict):
+                                child["extra"] = {}
+                            child["extra"]["mismatch_type"] = child_type
+                        children.append(child)
+                        consumed.add(cid)
+
+                if not c.get("extra") or not isinstance(c["extra"], dict):
+                    c["extra"] = {}
+                c["extra"]["children"] = children
+
+        new_commits.append(c)
+
+    filtered = [c for c in new_commits if c["id"] not in consumed]
+    context[0]["commits"] = filtered
+
+    json.dump(context, sys.stdout, indent=4)
+
+if __name__ == "__main__":
+    main(sys.argv[1] if len(sys.argv) > 1 else None)

scripts/generate-unreleased-changelog.sh

@@ -8,7 +8,9 @@ GIT_BRANCH="${GITHUB_REF##refs/heads/}"
 # === Step 1: Generate Changelog (only if file exists or on main) ===
 if [[ -f "$CHANGELOG_FILE" || "$GIT_BRANCH" == "main" ]]; then
   echo "📄 Generating $CHANGELOG_FILE using git-cliff..."
-  git-cliff -c "$CLIFF_CONFIG" -o "$CHANGELOG_FILE"
+  git-cliff -c "$CLIFF_CONFIG" --context \
+|   "${GITHUB_ACTION_PATH}/scripts/augment_context.py" \
+|   git-cliff -c "$CLIFF_CONFIG" --from-context - -o "$CHANGELOG_FILE"
 else
   echo "ℹ️  $CHANGELOG_FILE does not exist and branch is not 'main'. Skipping generation."
   exit 0

scripts/install-python.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+# install-python.sh – installs the latest Python version through apt
+# Usage: sudo ./install-python.sh
+set -euo pipefail
+
+if command -v python3 >/dev/null 2>&1; then
+    echo "ℹ️ Python $(python3 --version) is already installed"
+    exit 0
+fi
+
+apt update
+apt install -y python3
+
+echo "✅ Python $(python3 --version) installed"

scripts/release-from-version.sh

@@ -64,7 +64,9 @@ echo "📦 Version: $VERSION"
 
 # === Step 2: Generate changelog for release ===
 echo "📄 Generating changelog for tag v$VERSION"
-git-cliff -c "$CLIFF_CONFIG" -t "v$VERSION" -o "$CHANGELOG_FILE"
+git-cliff -c "$CLIFF_CONFIG" -t "v$VERSION" --context \
+|   "${GITHUB_ACTION_PATH}/scripts/augment_context.py" \
+|   git-cliff -c "$CLIFF_CONFIG"  -t "v$VERSION" --from-context - -o "$CHANGELOG_FILE"
 
 ESCAPED_VERSION="$(echo "$VERSION" | sed 's/\./\\./g')"