Compare commits
45 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| fa1a8673f6 | |||
|
d08cc144ed
|
|||
| 073026d7c9 | |||
|
94980be3e5
|
|||
| 4bd419d38f | |||
|
a6ee83e109
|
|||
| 3e6b722501 | |||
|
fedcc1ff41
|
|||
| 399f0edb40 | |||
|
73a1b5cc24
|
|||
| ddda682c80 | |||
|
121ea5b57a
|
|||
| 4d248aefd1 | |||
|
8de8b47038
|
|||
| 313ace34fe | |||
|
df2ba3b060
|
|||
|
27ee1746db
|
|||
| 03add717be | |||
|
01986944f0
|
|||
|
c25b2e9cd5
|
|||
| f44f457e6b | |||
|
169d9ec4db
|
|||
|
cbcd5e2ab7
|
|||
| ef3ac462ba | |||
|
d27a0cbd80
|
|||
|
1d9659b6df
|
|||
| 40ca5c987d | |||
|
d8700af97d
|
|||
|
856565d87f
|
|||
| 6b937d6408 | |||
|
d11131d9b2
|
|||
|
e5f5084931
|
|||
| 5eafa06477 | |||
|
039a14a473
|
|||
| 36e60c24ac | |||
|
525d8bfc44
|
|||
|
a4ff409fd8
|
|||
|
b6151b793d
|
|||
|
374f30a502
|
|||
| 70ae9ebc85 | |||
|
94d69f193a
|
|||
|
b75e412192
|
|||
| 06d36e5aba | |||
|
734002a8f1
|
|||
|
8a3960ad87
|
@@ -17,3 +17,4 @@ jobs:
|
||||
uses: https://git.0xmax42.io/actions/auto-changelog-release-action@v0
|
||||
with:
|
||||
token: ${{ secrets.RELEASE_PUBLISH_TOKEN }}
|
||||
allow_non_main_release: "true"
|
||||
|
||||
80
CHANGELOG.md
80
CHANGELOG.md
@@ -2,6 +2,86 @@
|
||||
|
||||
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
|
||||
|
||||
### ⚙️ 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
|
||||
|
||||
- *(script)* Use dynamic branch name for git push - ([27ee174](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/27ee1746dbc7b2c6c1564a04c024337ff158a9c5))
|
||||
|
||||
## [0.4.2](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.4.1..v0.4.2) - 2025-06-29
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
- *(action)* Update conditions for version detection - ([c25b2e9](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/c25b2e9cd551e923b84cd144b818940fd5e1ccff))
|
||||
|
||||
## [0.4.1](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.4.0..v0.4.1) - 2025-06-29
|
||||
|
||||
### 🐛 Bug Fixes
|
||||
|
||||
- *(action)* Standardize input key naming - ([cbcd5e2](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/cbcd5e2ab7e7f2498021d5043da9999f62dcf44d))
|
||||
|
||||
## [0.4.0](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.3.6..v0.4.0) - 2025-06-29
|
||||
|
||||
### 🚀 Features
|
||||
|
||||
- *(action)* Add support for non-main branch releases - ([1d9659b](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/1d9659b6df0d63ed17432e677ee77a4c17d2f2f3))
|
||||
|
||||
## [0.3.6](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.3.5..v0.3.6) - 2025-06-29
|
||||
|
||||
### ◀️ Revert
|
||||
|
||||
- Integrate gha-timer for step timing - ([856565d](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/856565d87f2575d6883705ddde3d177555c1bd86))
|
||||
|
||||
## [0.3.5](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.3.4..v0.3.5) - 2025-06-29
|
||||
|
||||
### 🚀 Features
|
||||
|
||||
- *(action)* Integrate gha-timer for step timing - ([e5f5084](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/e5f50849316f5dc0b045ac696c3628e610bae695))
|
||||
|
||||
### ◀️ Revert
|
||||
|
||||
- Improve CI readability with grouped git setup logs - ([039a14a](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/039a14a473493fd74fb61b60910652db3cfd5976))
|
||||
|
||||
## [0.3.4](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.3.2..v0.3.4) - 2025-06-29
|
||||
|
||||
### ⚙️ Miscellaneous Tasks
|
||||
|
||||
- *(workflows)* Update action to specific version - ([a4ff409](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/a4ff409fd812a5ccd2291251de5cd2af9bb0e713))
|
||||
- *(scripts)* Update file permissions to executable - ([374f30a](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/374f30a50206a426b8de7a0b78cde9ad4194469f))
|
||||
|
||||
## [0.3.2](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.3.1..v0.3.2) - 2025-06-29
|
||||
|
||||
### 🚜 Refactor
|
||||
|
||||
- *(action)* Simplify script invocation syntax - ([b75e412](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/b75e4121928131c1a1c0cbdea954a4fd602edd1a))
|
||||
|
||||
## [0.3.1](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.3.0..v0.3.1) - 2025-06-29
|
||||
|
||||
### ⚙️ Miscellaneous Tasks
|
||||
|
||||
- *(scripts)* Improve CI readability with grouped git setup logs - ([8a3960a](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/8a3960ad8712bc29823dc601a120a61582fa2a3b))
|
||||
|
||||
## [0.3.0](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.2.3..v0.3.0) - 2025-06-20
|
||||
|
||||
### 🚀 Features
|
||||
|
||||
29
action.yml
29
action.yml
@@ -14,6 +14,10 @@ inputs:
|
||||
description: "Commit-Autore-Mail"
|
||||
required: false
|
||||
default: ""
|
||||
allow_non_main_release:
|
||||
description: "Allow publishing releases from branches other than 'main'."
|
||||
required: false
|
||||
default: "false"
|
||||
|
||||
runs:
|
||||
using: "composite"
|
||||
@@ -25,34 +29,43 @@ runs:
|
||||
GITHUB_EVENT_BEFORE: ${{ github.event.before || '' }}
|
||||
GITHUB_SHA: ${{ github.sha || '' }}
|
||||
GITHUB_REF: ${{ github.ref || '' }}
|
||||
ALLOW_NON_MAIN_RELEASE: ${{ inputs.allow_non_main_release }}
|
||||
run: |
|
||||
bash ${{ github.action_path }}/scripts/detect-version-change.sh
|
||||
${{ github.action_path }}/scripts/detect-version-change.sh
|
||||
|
||||
- name: Read CLIFF_VERSION
|
||||
shell: bash
|
||||
id: cliff_version
|
||||
run: bash ${{ github.action_path }}/scripts/read-cliff-version.sh
|
||||
run: |
|
||||
${{ github.action_path }}/scripts/read-cliff-version.sh
|
||||
|
||||
- name: Install git-cliff
|
||||
shell: bash
|
||||
run: |
|
||||
bash ${{ github.action_path }}/scripts/install-git-cliff.sh "${{ steps.cliff_version.outputs.version }}"
|
||||
${{ 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: |
|
||||
bash ${{ github.action_path }}/scripts/setup-git.sh \
|
||||
${{ 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' || github.ref != 'refs/heads/main'
|
||||
if: steps.detect.outputs.version_changed == 'false'
|
||||
shell: bash
|
||||
run: bash ${{ github.action_path }}/scripts/generate-unreleased-changelog.sh
|
||||
run: |
|
||||
${{ github.action_path }}/scripts/generate-unreleased-changelog.sh
|
||||
|
||||
- name: Release from VERSION
|
||||
if: steps.detect.outputs.version_changed == 'true' && github.ref == 'refs/heads/main'
|
||||
if: steps.detect.outputs.version_changed == 'true'
|
||||
shell: bash
|
||||
env:
|
||||
RELEASE_PUBLISH_TOKEN: ${{ inputs.token || '' }}
|
||||
run: bash ${{ github.action_path }}/scripts/release-from-version.sh
|
||||
run: |
|
||||
${{ github.action_path }}/scripts/release-from-version.sh
|
||||
|
||||
25
cliff.toml
25
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,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,26 @@ 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 }}))\
|
||||
{% 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 }}))\
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% endfor %}\
|
||||
{% endfor %}\n
|
||||
"""
|
||||
# template for the changelog footer
|
||||
footer = """
|
||||
|
||||
"""
|
||||
|
||||
59
scripts/augment_context.py
Executable file
59
scripts/augment_context.py
Executable file
@@ -0,0 +1,59 @@
|
||||
#!/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)
|
||||
@@ -6,14 +6,17 @@ GIT_REF="${GITHUB_REF:-}"
|
||||
COMMIT_BEFORE="${GITHUB_EVENT_BEFORE:-}"
|
||||
COMMIT_AFTER="${GITHUB_SHA:-}"
|
||||
VERSION_FILE="VERSION"
|
||||
ALLOW_NON_MAIN_RELEASE="${ALLOW_NON_MAIN_RELEASE:-false}"
|
||||
|
||||
echo "🔍 Comparing commits:"
|
||||
echo "Before: $COMMIT_BEFORE"
|
||||
echo "After: $COMMIT_AFTER"
|
||||
echo "Ref: $GIT_REF"
|
||||
echo "Allow release from non-main branches: $ALLOW_NON_MAIN_RELEASE"
|
||||
|
||||
# Check branch condition
|
||||
if [[ "$GIT_REF" != "refs/heads/main" ]]; then
|
||||
echo "Not on 'main' branch – skipping version check."
|
||||
if [[ "$ALLOW_NON_MAIN_RELEASE" != "true" && "$GIT_REF" != "refs/heads/main" ]]; then
|
||||
echo "🚫 Not on 'main' branch and non-main releases are disabled – skipping version check."
|
||||
echo "version_changed=false" >> "$GITHUB_OUTPUT"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
4
scripts/generate-unreleased-changelog.sh
Normal file → Executable file
4
scripts/generate-unreleased-changelog.sh
Normal file → Executable 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
14
scripts/install-python.sh
Executable 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"
|
||||
0
scripts/read-cliff-version.sh
Normal file → Executable file
0
scripts/read-cliff-version.sh
Normal file → Executable file
7
scripts/release-from-version.sh
Normal file → Executable file
7
scripts/release-from-version.sh
Normal file → Executable file
@@ -52,6 +52,7 @@ VERSION_FILE="VERSION"
|
||||
CHANGELOG_FILE="CHANGELOG.md"
|
||||
CLIFF_CONFIG="cliff.toml"
|
||||
RELEASE_BODY_TMP="$(mktemp)"
|
||||
GIT_BRANCH="${GITHUB_REF##refs/heads/}"
|
||||
|
||||
# === Step 1: Read version ===
|
||||
if [[ ! -f "$VERSION_FILE" ]]; then
|
||||
@@ -63,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')"
|
||||
|
||||
@@ -87,7 +90,7 @@ if git diff --cached --quiet; then
|
||||
else
|
||||
echo "📝 Committing updated changelog"
|
||||
git commit -m "chore(changelog): update changelog for v$VERSION"
|
||||
git push origin main
|
||||
git push origin "$GIT_BRANCH"
|
||||
fi
|
||||
|
||||
# === Step 4: Create tag if necessary ===
|
||||
|
||||
0
scripts/setup-git.sh
Normal file → Executable file
0
scripts/setup-git.sh
Normal file → Executable file
Reference in New Issue
Block a user