22 Commits

Author SHA1 Message Date
5acddbc7c6 chore(changelog): update changelog for v1.1.0
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 12s
2025-09-29 18:54:04 +00:00
bfa7280ab3 chore(version): bump to 1.1.0
All checks were successful
Auto Changelog & Release / release (push) Successful in 15s
2025-09-29 20:53:47 +02:00
351303db0f chore(changelog): update unreleased changelog 2025-09-29 18:47:10 +00:00
e8426bb839 feat(scripts): add type extraction and mismatch detection logic
All checks were successful
Auto Changelog & Release / release (push) Successful in 12s
2025-09-29 20:46:44 +02:00
bb6e1d44b8 chore(changelog): update unreleased changelog 2025-09-27 20:31:28 +00:00
f54df9fbc4 docs: add changelog improvement ideas to TODO file
All checks were successful
Auto Changelog & Release / release (push) Successful in 14s
2025-09-27 22:31:15 +02:00
f1541e7d5d chore(changelog): update unreleased changelog 2025-09-27 20:22:04 +00:00
65462f5a14 chore(config): improve child commit handling in merge template
All checks were successful
Auto Changelog & Release / release (push) Successful in 14s
2025-09-27 22:21:46 +02:00
fa1a8673f6 chore(changelog): update changelog for v1.0.1
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 12s
2025-09-27 20:10:24 +00:00
d08cc144ed chore(version): bump to 1.0.1
All checks were successful
Auto Changelog & Release / release (push) Successful in 14s
2025-09-27 22:10:07 +02:00
073026d7c9 chore(changelog): update unreleased changelog 2025-09-27 20:09:47 +00:00
94980be3e5 chore(scripts): check for existing Python installation
All checks were successful
Auto Changelog & Release / release (push) Successful in 14s
2025-09-27 22:09:32 +02:00
4bd419d38f chore(changelog): update changelog for v1.0.0
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 12s
2025-09-27 19:58:13 +00:00
a6ee83e109 chore(version): bump to 1.0.0
All checks were successful
Auto Changelog & Release / release (push) Successful in 15s
2025-09-27 21:57:56 +02:00
3e6b722501 chore(changelog): update unreleased changelog 2025-09-27 19:57:01 +00:00
fedcc1ff41 fix(release): fix changelog generation pipe usage
All checks were successful
Auto Changelog & Release / release (push) Successful in 16s
2025-09-27 21:56:43 +02:00
399f0edb40 chore(changelog): update unreleased changelog 2025-09-27 19:55:35 +00:00
73a1b5cc24 chore(release): update action version in workflow
All checks were successful
Auto Changelog & Release / release (push) Successful in 20s
2025-09-27 21:53:35 +02:00
ddda682c80 chore(changelog): update unreleased changelog 2025-09-27 19:53:02 +00:00
121ea5b57a chore(ci): allow non-main branch releases
All checks were successful
Auto Changelog & Release / release (push) Successful in 10s
2025-09-27 21:49:18 +02:00
4d248aefd1 chore(changelog): update unreleased changelog 2025-09-27 19:48:46 +00:00
8de8b47038 feat(ci)!: enhance changelog generation with context augmentation
All checks were successful
Auto Changelog & Release / release (push) Successful in 13s
2025-09-27 21:44:20 +02:00
12 changed files with 259 additions and 91 deletions

View File

@@ -1,11 +0,0 @@
name: "with-post-step"
description: "Runs a main command and, afterwards, a post command."
inputs:
main: { description: "Command for the main step", required: true }
post: { description: "Command for the post step", required: true }
key: { description: "State key", default: POST }
runs:
using: node20
main: main.js
post: main.js

View File

@@ -1,18 +0,0 @@
const { spawn } = require("child_process");
const { appendFileSync } = require("fs");
const { EOL } = require("os");
function run(cmd) {
const proc = spawn(cmd, { stdio: "inherit", shell: true });
proc.on("exit", code => process.exitCode = code);
}
const key = process.env.INPUT_KEY.toUpperCase();
if (process.env[`STATE_${key}`] !== undefined) {
// ---------- POST ----------
run(process.env.INPUT_POST);
} else {
// ---------- MAIN ----------
appendFileSync(process.env.GITHUB_STATE, `${key}=true${EOL}`);
run(process.env.INPUT_MAIN);
}

View File

@@ -2,12 +2,40 @@
All notable changes to this project will be documented in this file.
## [2.0.1](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.4.3..v2.0.1) - 2025-07-04
## [1.1.0](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v1.0.1..v1.1.0) - 2025-09-29
### 🚀 Features
- *(workflows)* Allow non-main branch releases - ([09e4174](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/09e41744fbf920c0253e13644cb38f1dd430c0f3))
- *(actions)* Add post-step support for composite actions - ([543b311](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/543b311d1eb1fb83e8e0ef4014c549e61a863038))
- *(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

46
TODO.md Normal file
View File

@@ -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](...))
```
---

View File

@@ -1 +1 @@
2.0.1
1.1.0

View File

@@ -1,46 +1,71 @@
name: "Auto Changelog & Release"
description: "Detects version bump and, in post-step, writes changelog or publishes release."
name: Auto Changelog & Release
description: "One-stop composite action for version-bump detection, changelog generation and Gitea release."
inputs:
token: { description: "Gitea/GitHub PAT", default: "" }
author_name: { description: "Commit author", default: "" }
author_email: { description: "Commit e-mail", default: "" }
token:
description: "Gitea/GitHub PAT für Release-API"
required: false
default: ""
author_name:
description: "Commit-Autorname"
required: false
default: ""
author_email:
description: "Commit-Autore-Mail"
required: false
default: ""
allow_non_main_release:
description: "Allow release on branches main"
description: "Allow publishing releases from branches other than 'main'."
required: false
default: "false"
outputs:
release:
description: "true if VERSION changed"
value: ${{ steps.detect.outputs.version_changed }}
runs:
using: composite
using: "composite"
steps:
- id: detect
name: Detect version change + queue post work
uses: ./.gitea/actions/with-post-step
with:
key: AUTOCHANGELOG
#################### MAIN ####################
main: |
${{ github.action_path }}/scripts/detect-version-change.sh
#################### POST ####################
post: |
#!/usr/bin/env bash
set -euo pipefail
# VERSION_CHANGED kommt aus detect-Script via $GITHUB_ENV
CLIFF_VERSION="$(
${{ github.action_path }}/scripts/read-cliff-version.sh | tail -n1
)"
"${{ github.action_path }}/scripts/install-git-cliff.sh" "$CLIFF_VERSION"
"${{ github.action_path }}/scripts/setup-git.sh" \
"${{ inputs.author_name }}" "${{ inputs.author_email }}"
if [[ "${VERSION_CHANGED:-false}" == "true" ]]; then
# --- Release-Pfad ---
RELEASE_PUBLISH_TOKEN='${{ inputs.token }}' \
"${{ github.action_path }}/scripts/release-from-version.sh"
else
# --- Nur Changelog aktualisieren ---
"${{ github.action_path }}/scripts/generate-unreleased-changelog.sh"
fi
- name: Detect version change
shell: bash
id: detect
env:
GITHUB_EVENT_BEFORE: ${{ github.event.before || '' }}
GITHUB_SHA: ${{ github.sha || '' }}
GITHUB_REF: ${{ github.ref || '' }}
ALLOW_NON_MAIN_RELEASE: ${{ inputs.allow_non_main_release }}
run: |
${{ github.action_path }}/scripts/detect-version-change.sh
- name: Read CLIFF_VERSION
shell: bash
id: cliff_version
run: |
${{ github.action_path }}/scripts/read-cliff-version.sh
- name: Install git-cliff
shell: bash
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: |
${{ github.action_path }}/scripts/setup-git.sh \
"${{ inputs.author_name }}" \
"${{ inputs.author_email }}"
- name: Generate and commit changelog (unreleased)
if: steps.detect.outputs.version_changed == 'false'
shell: bash
run: |
${{ github.action_path }}/scripts/generate-unreleased-changelog.sh
- name: Release from VERSION
if: steps.detect.outputs.version_changed == 'true'
shell: bash
env:
RELEASE_PUBLISH_TOKEN: ${{ inputs.token || '' }}
run: |
${{ github.action_path }}/scripts/release-from-version.sh

View File

@@ -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,18 +10,15 @@ 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 }}
@@ -38,16 +35,28 @@ body = """
## [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 }} - \
([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
{% endfor %}
### {{ 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.extra and commit.extra.children %}\
{% for child in commit.extra.children %}
{{ " " | safe }}- {% 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 }}))\
{% endif %}
{% endfor %}\
{% endfor %}\n
"""
# template for the changelog footer
footer = """
"""

72
scripts/augment_context.py Executable file
View File

@@ -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)

View File

@@ -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

14
scripts/install-python.sh Executable file
View File

@@ -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"

View File

@@ -12,11 +12,10 @@ fi
VERSION_LINE=$(awk -F '=' '/^# CLIFF_VERSION=/ { gsub(/[" ]/, "", $2); print $2 }' "$CLIFF_TOML" || true)
if [[ -n "$VERSION_LINE" ]]; then
echo "✅ Extracted CLIFF_VERSION: $VERSION_LINE" >&2
echo "✅ Extracted CLIFF_VERSION: $VERSION_LINE"
else
echo "⚠️ No CLIFF_VERSION found in $CLIFF_TOML" >&2
echo "⚠️ No CLIFF_VERSION found in $CLIFF_TOML"
fi
# Output für GitHub Actions / Composite Action
echo "version=${VERSION_LINE:-}" >> "$GITHUB_OUTPUT"
echo "$VERSION_LINE"
n

View File

@@ -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')"