Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 5abdff1d1c | |||
|
ec44bde050
|
|||
|
30f83b08ee
|
|||
| 5771982931 | |||
|
2df09c467e
|
|||
|
09e41744fb
|
|||
| e12595d0a8 | |||
|
4254a7f534
|
|||
|
543b311d1e
|
20
CHANGELOG.md
20
CHANGELOG.md
@@ -2,26 +2,18 @@
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## [1.0.1](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v1.0.0..v1.0.1) - 2025-09-27
|
||||
## [2.0.2](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v2.0.1..v2.0.2) - 2025-07-04
|
||||
|
||||
### ⚙️ Miscellaneous Tasks
|
||||
### 🚜 Refactor
|
||||
|
||||
- *(scripts)* Check for existing Python installation - ([94980be](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/94980be3e5e5827b75edf9abeab0987709fa3122))
|
||||
- *(actions)* Simplify action path structure - ([30f83b0](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/30f83b08eecabe17b7d1f53aaf0bb4d0cdd82256))
|
||||
|
||||
## [1.0.0](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.4.3..v1.0.0) - 2025-09-27
|
||||
## [2.0.1](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.4.3..v2.0.1) - 2025-07-04
|
||||
|
||||
### 🚀 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
|
||||
|
||||
|
||||
103
action.yml
103
action.yml
@@ -1,71 +1,46 @@
|
||||
name: Auto Changelog & Release
|
||||
description: "One-stop composite action for version-bump detection, changelog generation and Gitea release."
|
||||
name: "Auto Changelog & Release"
|
||||
description: "Detects version bump and, in post-step, writes changelog or publishes release."
|
||||
|
||||
inputs:
|
||||
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: ""
|
||||
token: { description: "Gitea/GitHub PAT", default: "" }
|
||||
author_name: { description: "Commit author", default: "" }
|
||||
author_email: { description: "Commit e-mail", default: "" }
|
||||
allow_non_main_release:
|
||||
description: "Allow publishing releases from branches other than 'main'."
|
||||
required: false
|
||||
description: "Allow release on branches ≠ main"
|
||||
default: "false"
|
||||
|
||||
outputs:
|
||||
release:
|
||||
description: "true if VERSION changed"
|
||||
value: ${{ steps.detect.outputs.version_changed }}
|
||||
|
||||
runs:
|
||||
using: "composite"
|
||||
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
|
||||
- id: detect
|
||||
name: Detect version change + queue post work
|
||||
uses: ./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
|
||||
|
||||
33
cliff.toml
33
cliff.toml
@@ -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,15 +10,18 @@ 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 }}
|
||||
@@ -35,26 +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 }}))\
|
||||
{% 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 %}\
|
||||
{% 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 = """
|
||||
|
||||
"""
|
||||
|
||||
@@ -1,59 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
import json
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
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
|
||||
|
||||
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:
|
||||
children.append(commits_by_id[cid])
|
||||
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)
|
||||
@@ -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
|
||||
|
||||
@@ -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"
|
||||
@@ -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
|
||||
@@ -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')"
|
||||
|
||||
|
||||
11
with-post-step/action.yml
Normal file
11
with-post-step/action.yml
Normal file
@@ -0,0 +1,11 @@
|
||||
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
|
||||
18
with-post-step/main.js
Normal file
18
with-post-step/main.js
Normal file
@@ -0,0 +1,18 @@
|
||||
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);
|
||||
}
|
||||
Reference in New Issue
Block a user