12 Commits

Author SHA1 Message Date
6b4016177f chore(changelog): update changelog for v2.0.3
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 5s
2025-07-04 09:43:50 +00:00
33c5c71923 chore(version): bump version to 2.0.3
All checks were successful
Auto Changelog & Release / release (push) Successful in 9s
2025-07-04 11:43:40 +02:00
8df31fb97e refactor(action): simplify composite action structure
- Replaces custom with-post-step logic with Node.js-based implementation
- Consolidates main and post scripts for clarity and maintainability
- Updates descriptions and input definitions for improved readability
2025-07-04 11:43:25 +02:00
5abdff1d1c chore(changelog): update changelog for v2.0.2
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 5s
2025-07-04 09:35:24 +00:00
ec44bde050 chore(version): bump version to 2.0.2
All checks were successful
Auto Changelog & Release / release (push) Successful in 7s
- Updates version number from 2.0.1 to 2.0.2
2025-07-04 11:35:16 +02:00
30f83b08ee refactor(actions): simplify action path structure
- Relocates action files to a flat directory structure
- Updates references to the new paths for better organization
2025-07-04 11:35:16 +02:00
5771982931 chore(changelog): update changelog for v2.0.1
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 4s
2025-07-04 09:32:27 +00:00
2df09c467e chore(version): bump version to 2.0.1
All checks were successful
Auto Changelog & Release / release (push) Successful in 8s
2025-07-04 11:32:16 +02:00
09e41744fb feat(workflows): allow non-main branch releases
- Updates the release action version for compatibility
- Adds support for releasing from non-main branches
2025-07-04 11:32:10 +02:00
e12595d0a8 chore(changelog): update unreleased changelog 2025-07-04 09:28:58 +00:00
4254a7f534 chore(version): update version to 2.0.0
All checks were successful
Auto Changelog & Release / release (push) Successful in 7s
2025-07-04 11:28:44 +02:00
543b311d1e feat(actions): add post-step support for composite actions 2025-07-04 11:28:36 +02:00
12 changed files with 131 additions and 276 deletions

View File

@@ -2,40 +2,24 @@
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
## [2.0.3](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v2.0.2..v2.0.3) - 2025-07-04
### 🚜 Refactor
- *(action)* Simplify composite action structure - ([8df31fb](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/8df31fb97ebd73e71b2f8a9dc925fe8a81192be3))
## [2.0.2](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v2.0.1..v2.0.2) - 2025-07-04
### 🚜 Refactor
- *(actions)* Simplify action path structure - ([30f83b0](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/30f83b08eecabe17b7d1f53aaf0bb4d0cdd82256))
## [2.0.1](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.4.3..v2.0.1) - 2025-07-04
### 🚀 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))
- *(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))
## [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
View File

@@ -1,46 +0,0 @@
# 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 @@
1.1.0
2.0.3

View File

@@ -1,5 +1,5 @@
name: Auto Changelog & Release
description: "One-stop composite action for version-bump detection, changelog generation and Gitea release."
description: One-stop composite action
inputs:
token:
@@ -19,53 +19,11 @@ inputs:
required: false
default: "false"
outputs:
release:
description: "Whether a release should be made (true/false)"
runs:
using: "composite"
steps:
- 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
using: "node20"
main: "dist/main.js"
post: "dist/post.js"

View File

@@ -1,4 +1,4 @@
# CLIFF_VERSION=2.10.1
# CLIFF_VERSION=2.8.0
# git-cliff ~ default configuration file
# https://git-cliff.org/docs/configuration
#
@@ -10,27 +10,23 @@ owner = "actions"
repo = "auto-changelog-release-action"
[changelog]
# postprocessors
postprocessors = [
{ pattern = '<GITEA_URL>', replace = "https://git.0xmax42.io" }, # replace gitea url
{ 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") }}]\
@@ -42,29 +38,16 @@ body = """
## [unreleased]
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
### {{ 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 }}))\
{% endif %}
{% endfor %}\
### {{ 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 %}
{% endfor %}\n
"""
# template for the changelog footer
footer = """
"""
@@ -85,31 +68,31 @@ filter_unconventional = true
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 -' },
# 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\\(changelog\\)", skip = true },
{ message = "^chore\\(version\\)", skip = true },
{ 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" },
{ message = ".*", group = "<!-- 10 -->💼 Other" },
{ 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\\(changelog\\)", skip = true },
{ message = "^chore\\(version\\)", skip = true },
{ 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" },
{ message = ".*", group = "<!-- 10 -->💼 Other" },
]
# Regex to select git tags that represent releases.
tag_pattern = "v[0-9]+\\.[0-9]+\\.[0-9]+"

34
dist/main.js vendored Normal file
View File

@@ -0,0 +1,34 @@
const cp = require("child_process");
const path = require("path");
const fs = require("fs");
function run(script) {
cp.execFileSync(script, { stdio: "inherit", shell: true });
}
function exportOutput(key, value) {
fs.appendFileSync(process.env.GITHUB_OUTPUT, `${key}=${value}\n`);
}
function setEnv(key, value) {
fs.appendFileSync(process.env.GITHUB_ENV, `${key}=${value}\n`);
}
function main() {
const actionPath = process.env.GITHUB_ACTION_PATH || ".";
const script = path.join(actionPath, "scripts/detect-version-change.sh");
run(script);
// Hier nehmen wir an, dass das Script selbst bereits `version_changed=true/false`
// in $GITHUB_OUTPUT geschrieben hat.
// Zur Sicherheit lesen wir das nochmal aus und speichern es auch als release-Flag.
const output = fs.readFileSync(process.env.GITHUB_OUTPUT, "utf-8");
const match = output.match(/^version_changed=(.*)$/m);
const value = match?.[1]?.trim() || "false";
exportOutput("release", value);
setEnv("VERSION_CHANGED", value);
}
main();

31
dist/post.js vendored Normal file
View File

@@ -0,0 +1,31 @@
const cp = require("child_process");
const path = require("path");
function run(script, args = []) {
cp.execFileSync(script, {
stdio: "inherit",
shell: true,
env: process.env,
});
}
function main() {
const actionPath = process.env.GITHUB_ACTION_PATH || ".";
const versionChanged = (process.env.VERSION_CHANGED || "false").toLowerCase() === "true";
const readCliff = path.join(actionPath, "scripts/read-cliff-version.sh");
const cliffVersion = cp.execSync(readCliff, { encoding: "utf-8", shell: true }).trim().split("\n").pop();
run(path.join(actionPath, "scripts/install-git-cliff.sh"), [cliffVersion]);
run(`${path.join(actionPath, "scripts/setup-git.sh")} "${process.env.INPUT_AUTHOR_NAME}" "${process.env.INPUT_AUTHOR_EMAIL}"`);
if (versionChanged) {
process.env.RELEASE_PUBLISH_TOKEN = process.env.INPUT_TOKEN || "";
run(path.join(actionPath, "scripts/release-from-version.sh"));
} else {
run(path.join(actionPath, "scripts/generate-unreleased-changelog.sh"));
}
}
main();

View File

@@ -1,72 +0,0 @@
#!/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,9 +8,7 @@ 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" --context \
| "${GITHUB_ACTION_PATH}/scripts/augment_context.py" \
| git-cliff -c "$CLIFF_CONFIG" --from-context - -o "$CHANGELOG_FILE"
git-cliff -c "$CLIFF_CONFIG" -o "$CHANGELOG_FILE"
else
echo "ℹ️ $CHANGELOG_FILE does not exist and branch is not 'main'. Skipping generation."
exit 0

View File

@@ -1,14 +0,0 @@
#!/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,10 +12,11 @@ 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"
echo "✅ Extracted CLIFF_VERSION: $VERSION_LINE" >&2
else
echo "⚠️ No CLIFF_VERSION found in $CLIFF_TOML"
echo "⚠️ No CLIFF_VERSION found in $CLIFF_TOML" >&2
fi
# Output für GitHub Actions / Composite Action
echo "version=${VERSION_LINE:-}" >> "$GITHUB_OUTPUT"
echo "$VERSION_LINE"
n

View File

@@ -64,9 +64,7 @@ echo "📦 Version: $VERSION"
# === Step 2: Generate changelog for release ===
echo "📄 Generating changelog for tag v$VERSION"
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"
git-cliff -c "$CLIFF_CONFIG" -t "v$VERSION" -o "$CHANGELOG_FILE"
ESCAPED_VERSION="$(echo "$VERSION" | sed 's/\./\\./g')"