61 Commits

Author SHA1 Message Date
7246f2f4d8 chore(changelog): update changelog for v1.2.3
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 5s
2025-11-24 11:35:32 +00:00
2cfe12debc chore(version): bump version to 1.2.3
All checks were successful
Auto Changelog & Release / release (push) Successful in 7s
2025-11-24 12:35:25 +01:00
a24d031052 chore(changelog): update unreleased changelog 2025-11-24 11:35:11 +00:00
064677870b fix(ci): use ACTION_PATH for git-cliff config generation
All checks were successful
Auto Changelog & Release / release (push) Successful in 6s
2025-11-24 12:35:06 +01:00
f6713d9d6d chore(changelog): update changelog for v1.2.2
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 5s
2025-11-24 11:33:04 +00:00
81c4ef4913 chore(version): bump version to 1.2.2
All checks were successful
Auto Changelog & Release / release (push) Successful in 7s
2025-11-24 12:32:56 +01:00
867a5f3c6b chore(changelog): update unreleased changelog 2025-11-24 11:32:49 +00:00
e050996fd4 fix(scripts): improve version argument handling in install script
All checks were successful
Auto Changelog & Release / release (push) Successful in 5s
2025-11-24 12:32:43 +01:00
10d16c4858 chore(changelog): update changelog for v1.2.1
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 5s
2025-11-24 11:31:09 +00:00
f7473a5198 chore(version): bump version to 1.2.1
All checks were successful
Auto Changelog & Release / release (push) Successful in 6s
2025-11-24 12:31:02 +01:00
2e4bbd7091 chore(changelog): update unreleased changelog 2025-11-24 11:30:55 +00:00
ce5cb7bcc0 fix(scripts): remove redundant output on missing config file
All checks were successful
Auto Changelog & Release / release (push) Successful in 6s
2025-11-24 12:30:48 +01:00
454c5370df chore(changelog): update changelog for v1.2.0
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 6s
2025-11-24 11:28:38 +00:00
437fd0cdd0 chore(version): bump version to 1.2.0
All checks were successful
Auto Changelog & Release / release (push) Successful in 7s
2025-11-24 12:28:32 +01:00
2f224733f4 chore(changelog): update unreleased changelog 2025-11-24 11:28:13 +00:00
096ecb5822 feat: add templated git-cliff config generation to workflow
All checks were successful
Auto Changelog & Release / release (push) Successful in 6s
2025-11-24 12:28:05 +01:00
2a4931f295 chore(changelog): update unreleased changelog
All checks were successful
Auto Changelog & Release / release (push) Successful in 13s
2025-09-30 10:50:58 +00:00
d8bf0743f7 chore(config): adjust formatting and improve changelog parsing
All checks were successful
Auto Changelog & Release / release (push) Successful in 13s
2025-09-30 12:50:40 +02:00
a83ee3e88f feat(changelog): add support for indented commit bodies 2025-09-30 12:50:40 +02:00
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
313ace34fe chore(changelog): update changelog for v0.4.3
All checks were successful
Auto Changelog & Release / release (push) Successful in 13s
Create Major Version Tag / update-major-tag (release) Successful in 12s
2025-06-29 12:18:09 +00:00
df2ba3b060 chore(version): bump version to 0.4.3
All checks were successful
Auto Changelog & Release / release (push) Successful in 8s
2025-06-29 14:18:02 +02:00
27ee1746db fix(script): use dynamic branch name for git push 2025-06-29 14:18:02 +02:00
03add717be chore(changelog): update changelog for v0.4.2
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 4s
2025-06-29 12:13:42 +00:00
01986944f0 chore(version): bump version to 0.4.2
All checks were successful
Auto Changelog & Release / release (push) Successful in 8s
2025-06-29 14:13:34 +02:00
c25b2e9cd5 fix(action): update conditions for version detection
- Remove branch-specific checks from conditional statements
- Simplify logic for changelog generation and release steps
- Ensure consistent behavior regardless of branch context
2025-06-29 14:13:34 +02:00
f44f457e6b chore(changelog): update changelog for v0.4.1
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 4s
2025-06-29 12:11:27 +00:00
169d9ec4db chore(version): bump to 0.4.1
All checks were successful
Auto Changelog & Release / release (push) Successful in 7s
2025-06-29 14:11:17 +02:00
cbcd5e2ab7 fix(action): standardize input key naming
- Update input key from `allow-non-main-release` to `allow_non_main_release`
- Ensure consistency with environment variable naming convention
2025-06-29 14:11:17 +02:00
ef3ac462ba chore(changelog): update changelog for v0.4.0
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 4s
2025-06-29 12:10:01 +00:00
d27a0cbd80 chore(version): bump version to 0.4.0
All checks were successful
Auto Changelog & Release / release (push) Successful in 7s
2025-06-29 14:09:47 +02:00
1d9659b6df feat(action): add support for non-main branch releases
- Introduce an input to allow releases from non-main branches
- Update logic to conditionally permit version checks outside 'main'
2025-06-29 14:09:24 +02:00
40ca5c987d chore(changelog): update changelog for v0.3.6
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 4s
2025-06-29 11:52:17 +00:00
d8700af97d chore(version): bump version to 0.3.6
All checks were successful
Auto Changelog & Release / release (push) Successful in 8s
2025-06-29 13:52:08 +02:00
856565d87f revert: integrate gha-timer for step timing
This reverts commit e5f5084931.
2025-06-29 13:52:08 +02:00
6b937d6408 chore(changelog): update changelog for v0.3.5
All checks were successful
Create Major Version Tag / update-major-tag (release) Successful in 5s
2025-06-29 11:49:27 +00:00
d11131d9b2 chore(version): bump version to 0.3.5
All checks were successful
Auto Changelog & Release / release (push) Successful in 8s
2025-06-29 13:49:17 +02:00
e5f5084931 feat(action): integrate gha-timer for step timing
- Adds gha-timer to measure and log execution time for steps
- Improves visibility into step outcomes with success/failure logging
- Enhances debugging and performance analysis capability
2025-06-29 13:49:17 +02:00
5eafa06477 chore(changelog): update unreleased changelog 2025-06-29 11:42:15 +00:00
039a14a473 revert: improve CI readability with grouped git setup logs
All checks were successful
Auto Changelog & Release / release (push) Successful in 6s
This reverts commit 8a3960ad87.
2025-06-29 13:41:47 +02:00
16 changed files with 464 additions and 55 deletions

View File

@@ -14,6 +14,7 @@ jobs:
with: with:
fetch-depth: 0 fetch-depth: 0
- name: Release - 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: with:
token: ${{ secrets.RELEASE_PUBLISH_TOKEN }} token: ${{ secrets.RELEASE_PUBLISH_TOKEN }}
allow_non_main_release: "true"

View File

@@ -2,6 +2,110 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [1.2.3](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v1.2.2..v1.2.3) - 2025-11-24
### 🐛 Bug Fixes
- *(ci)* Use ACTION_PATH for git-cliff config generation - ([0646778](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/064677870b9ebac04d2f264fede191205faa0614))
## [1.2.2](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v1.2.1..v1.2.2) - 2025-11-24
### 🐛 Bug Fixes
- *(scripts)* Improve version argument handling in install script - ([e050996](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/e050996fd4d153f59cce0c9483851cae4963908d))
## [1.2.1](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v1.2.0..v1.2.1) - 2025-11-24
### 🐛 Bug Fixes
- *(scripts)* Remove redundant output on missing config file - ([ce5cb7b](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/ce5cb7bcc0435931a24b017c2fdacf03eb084032))
## [1.2.0](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v1.1.0..v1.2.0) - 2025-11-24
### 🚀 Features
- Add templated git-cliff config generation to workflow - ([096ecb5](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/096ecb582296cdd479a32d5eb58512af76621102))
- *(changelog)* Add support for indented commit bodies - ([a83ee3e](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/a83ee3e88f87c3d99368ee1e62f45f4f30dd46c1))
### ⚙️ Miscellaneous Tasks
- *(config)* Adjust formatting and improve changelog parsing - ([d8bf074](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/d8bf0743f7ece328d76a3cde52aac75b1691ada6))
## [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
- *(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 ## [0.3.4](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.3.2..v0.3.4) - 2025-06-29
### ⚙️ Miscellaneous Tasks ### ⚙️ Miscellaneous Tasks

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

View File

@@ -14,6 +14,10 @@ inputs:
description: "Commit-Autore-Mail" description: "Commit-Autore-Mail"
required: false required: false
default: "" default: ""
allow_non_main_release:
description: "Allow publishing releases from branches other than 'main'."
required: false
default: "false"
runs: runs:
using: "composite" using: "composite"
@@ -25,6 +29,7 @@ runs:
GITHUB_EVENT_BEFORE: ${{ github.event.before || '' }} GITHUB_EVENT_BEFORE: ${{ github.event.before || '' }}
GITHUB_SHA: ${{ github.sha || '' }} GITHUB_SHA: ${{ github.sha || '' }}
GITHUB_REF: ${{ github.ref || '' }} GITHUB_REF: ${{ github.ref || '' }}
ALLOW_NON_MAIN_RELEASE: ${{ inputs.allow_non_main_release }}
run: | run: |
${{ github.action_path }}/scripts/detect-version-change.sh ${{ github.action_path }}/scripts/detect-version-change.sh
@@ -34,11 +39,23 @@ runs:
run: | run: |
${{ github.action_path }}/scripts/read-cliff-version.sh ${{ github.action_path }}/scripts/read-cliff-version.sh
- name: Generate git-cliff config
env:
ACTION_PATH: ${{ github.action_path }}
shell: bash
run: |
${{ github.action_path }}/scripts/generate-git-cliff-config.sh
- name: Install git-cliff - name: Install git-cliff
shell: bash shell: bash
run: | run: |
${{ 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 - name: Set up git
shell: bash shell: bash
run: | run: |
@@ -47,13 +64,13 @@ runs:
"${{ inputs.author_email }}" "${{ inputs.author_email }}"
- name: Generate and commit changelog (unreleased) - 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 shell: bash
run: | run: |
${{ github.action_path }}/scripts/generate-unreleased-changelog.sh ${{ github.action_path }}/scripts/generate-unreleased-changelog.sh
- name: Release from VERSION - 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 shell: bash
env: env:
RELEASE_PUBLISH_TOKEN: ${{ inputs.token || '' }} RELEASE_PUBLISH_TOKEN: ${{ inputs.token || '' }}

View File

@@ -1,4 +1,4 @@
# CLIFF_VERSION=2.8.0 # CLIFF_VERSION=2.10.1
# git-cliff ~ default configuration file # git-cliff ~ default configuration file
# https://git-cliff.org/docs/configuration # https://git-cliff.org/docs/configuration
# #
@@ -10,23 +10,27 @@ owner = "actions"
repo = "auto-changelog-release-action" repo = "auto-changelog-release-action"
[changelog] [changelog]
# postprocessors
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 = """ header = """
# Changelog\n # Changelog\n
All notable changes to this project will be documented in this file.\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 = """ body = """
{%- macro remote_url() -%} {%- macro remote_url() -%}
<GITEA_URL>/{{ remote.gitea.owner }}/{{ remote.gitea.repo }} <GITEA_URL>/{{ remote.gitea.owner }}/{{ remote.gitea.repo }}
{%- endmacro -%} {%- 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 version %}\
{% if previous.version %}\ {% if previous.version %}\
## [{{ version | trim_start_matches(pat="v") }}]\ ## [{{ version | trim_start_matches(pat="v") }}]\
@@ -38,16 +42,29 @@ body = """
## [unreleased] ## [unreleased]
{% endif %}\ {% endif %}\
{% for group, commits in commits | group_by(attribute="group") %} {% for group, commits in commits | group_by(attribute="group") %}
### {{ group | striptags | trim | upper_first }} ### {{ group | striptags | trim | upper_first }}\n
{% for commit in commits %} {% 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.scope %}*({{ commit.scope }})* {% endif %}\
{% if commit.breaking %}[**breaking**] {% endif %}\ {% if commit.breaking %}[**breaking**] {% endif %}\
{{ commit.message | upper_first }} - \ {{ commit.message | upper_first }} - \
([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\ ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
{% endfor %} {% endif %}
{% endfor %}\
{% endfor %}\n {% endfor %}\n
""" """
# template for the changelog footer
footer = """ footer = """
""" """

120
cliff.toml.template Normal file
View File

@@ -0,0 +1,120 @@
# git-cliff ~ default configuration file
# https://git-cliff.org/docs/configuration
#
# Lines starting with "#" are comments.
# Configuration options are organized into tables and keys.
# See documentation for more information on available options.
[remote.gitea]
owner = "%OWNER%"
repo = "%REPO%"
[changelog]
postprocessors = [
{ pattern = '<GITEA_URL>', replace = "https://git.0xmax42.io" }, # replace gitea url
]
header = """
# Changelog\n
All notable changes to this project will be documented in this file.\n
"""
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") }}]\
({{ self::remote_url() }}/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% endif %}\
{% else %}\
## [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 %}\
{% endfor %}\n
"""
footer = """
"""
# remove the leading and trailing s
trim = true
# render body even when there are no releases to process
# render_always = true
# output file path
# output = "test.md"
[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = true
# filter out the commits that are not conventional
filter_unconventional = true
# process each line of a commit as an individual commit
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 -' },
]
# 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" },
]
# Regex to select git tags that represent releases.
tag_pattern = "v[0-9]+\\.[0-9]+\\.[0-9]+"
# filter out the commits that are not matched by commit parsers
filter_commits = false
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "newest"

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

@@ -6,14 +6,17 @@ GIT_REF="${GITHUB_REF:-}"
COMMIT_BEFORE="${GITHUB_EVENT_BEFORE:-}" COMMIT_BEFORE="${GITHUB_EVENT_BEFORE:-}"
COMMIT_AFTER="${GITHUB_SHA:-}" COMMIT_AFTER="${GITHUB_SHA:-}"
VERSION_FILE="VERSION" VERSION_FILE="VERSION"
ALLOW_NON_MAIN_RELEASE="${ALLOW_NON_MAIN_RELEASE:-false}"
echo "🔍 Comparing commits:" echo "🔍 Comparing commits:"
echo "Before: $COMMIT_BEFORE" echo "Before: $COMMIT_BEFORE"
echo "After: $COMMIT_AFTER" echo "After: $COMMIT_AFTER"
echo "Ref: $GIT_REF"
echo "Allow release from non-main branches: $ALLOW_NON_MAIN_RELEASE"
# Check branch condition # Check branch condition
if [[ "$GIT_REF" != "refs/heads/main" ]]; then if [[ "$ALLOW_NON_MAIN_RELEASE" != "true" && "$GIT_REF" != "refs/heads/main" ]]; then
echo "Not on 'main' branch – skipping version check." echo "🚫 Not on 'main' branch and non-main releases are disabled – skipping version check."
echo "version_changed=false" >> "$GITHUB_OUTPUT" echo "version_changed=false" >> "$GITHUB_OUTPUT"
exit 0 exit 0
fi fi

View File

@@ -0,0 +1,15 @@
#!/usr/bin/env bash
set -euo pipefail
CLIFF_CONFIG="cliff.toml"
# Check if cliff.toml exists, if not, copy cliff.toml.template from the Action
if [ ! -f "$CLIFF_CONFIG" ]; then
echo "cliff.toml not found, using template from action."
cp "$ACTION_PATH/cliff.toml.template" "$CLIFF_CONFIG"
# Replace placeholders in the copied config
OWNER="${GITHUB_REPOSITORY%/*}"
REPO="${GITHUB_REPOSITORY#*/}"
sed -i "s/owner = \"%OWNER%\"/owner = \"$OWNER\"/g" "$CLIFF_CONFIG"
sed -i "s/repo = \"%REPO%\"/repo = \"$REPO\"/g" "$CLIFF_CONFIG"
fi

View File

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

View File

@@ -7,7 +7,11 @@ set -euo pipefail
REPO="orhun/git-cliff" REPO="orhun/git-cliff"
ARCH_OS="x86_64-unknown-linux-gnu" ARCH_OS="x86_64-unknown-linux-gnu"
INSTALL_DIR="/usr/local/bin" INSTALL_DIR="/usr/local/bin"
VERSION="${1:-latest}" if [[ -z "${1:-}" ]]; then
VERSION="latest"
else
VERSION="$1"
fi
need() { command -v "$1" >/dev/null || { echo "$1 is missing"; exit 1; }; } need() { command -v "$1" >/dev/null || { echo "$1 is missing"; exit 1; }; }
need curl; need tar; need grep; need sed; need awk; need jq need curl; need tar; need grep; need sed; need awk; need jq

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

@@ -5,7 +5,6 @@ CLIFF_TOML="${1:-cliff.toml}"
if [[ ! -f "$CLIFF_TOML" ]]; then if [[ ! -f "$CLIFF_TOML" ]]; then
echo "❌ File not found: $CLIFF_TOML" >&2 echo "❌ File not found: $CLIFF_TOML" >&2
echo "version=" >> "$GITHUB_OUTPUT"
exit 0 exit 0
fi fi

View File

@@ -52,6 +52,7 @@ VERSION_FILE="VERSION"
CHANGELOG_FILE="CHANGELOG.md" CHANGELOG_FILE="CHANGELOG.md"
CLIFF_CONFIG="cliff.toml" CLIFF_CONFIG="cliff.toml"
RELEASE_BODY_TMP="$(mktemp)" RELEASE_BODY_TMP="$(mktemp)"
GIT_BRANCH="${GITHUB_REF##refs/heads/}"
# === Step 1: Read version === # === Step 1: Read version ===
if [[ ! -f "$VERSION_FILE" ]]; then if [[ ! -f "$VERSION_FILE" ]]; then
@@ -63,7 +64,9 @@ echo "📦 Version: $VERSION"
# === Step 2: Generate changelog for release === # === Step 2: Generate changelog for release ===
echo "📄 Generating changelog for tag v$VERSION" 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')" ESCAPED_VERSION="$(echo "$VERSION" | sed 's/\./\\./g')"
@@ -87,7 +90,7 @@ if git diff --cached --quiet; then
else else
echo "📝 Committing updated changelog" echo "📝 Committing updated changelog"
git commit -m "chore(changelog): update changelog for v$VERSION" git commit -m "chore(changelog): update changelog for v$VERSION"
git push origin main git push origin "$GIT_BRANCH"
fi fi
# === Step 4: Create tag if necessary === # === Step 4: Create tag if necessary ===

View File

@@ -1,9 +1,6 @@
#!/usr/bin/env bash #!/usr/bin/env bash
set -euo pipefail set -euo pipefail
# Open a log group for better readability in CI pipelines
echo "::group::🔧 Git Author Setup"
# Optional inputs (positionals) or fallback to environment variables # Optional inputs (positionals) or fallback to environment variables
AUTHOR_NAME="${1:-${CI_COMMIT_AUTHOR_NAME:-CI Bot}}" AUTHOR_NAME="${1:-${CI_COMMIT_AUTHOR_NAME:-CI Bot}}"
AUTHOR_EMAIL="${2:-${CI_COMMIT_AUTHOR_EMAIL:-ci@bot.none}}" AUTHOR_EMAIL="${2:-${CI_COMMIT_AUTHOR_EMAIL:-ci@bot.none}}"
@@ -21,17 +18,12 @@ CONFIGURED_EMAIL=$(git config --global user.email)
if [[ "$CONFIGURED_NAME" != "$AUTHOR_NAME" ]]; then if [[ "$CONFIGURED_NAME" != "$AUTHOR_NAME" ]]; then
echo "❌ Error: Git username was not set correctly!" >&2 echo "❌ Error: Git username was not set correctly!" >&2
echo "::endgroup::"
exit 1 exit 1
fi fi
if [[ "$CONFIGURED_EMAIL" != "$AUTHOR_EMAIL" ]]; then if [[ "$CONFIGURED_EMAIL" != "$AUTHOR_EMAIL" ]]; then
echo "❌ Error: Git email was not set correctly!" >&2 echo "❌ Error: Git email was not set correctly!" >&2
echo "::endgroup::"
exit 1 exit 1
fi fi
echo "✅ Git configuration completed successfully." echo "✅ Git configuration completed successfully."
# Close the log group
echo "::endgroup::"