Compare commits
66 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 454c5370df | |||
|
437fd0cdd0
|
|||
| 2f224733f4 | |||
|
096ecb5822
|
|||
| 2a4931f295 | |||
|
d8bf0743f7
|
|||
|
a83ee3e88f
|
|||
| 5acddbc7c6 | |||
|
bfa7280ab3
|
|||
| 351303db0f | |||
|
e8426bb839
|
|||
| bb6e1d44b8 | |||
|
f54df9fbc4
|
|||
| f1541e7d5d | |||
|
65462f5a14
|
|||
| 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
|
|||
| 518d1a2055 | |||
|
eadc2ebc63
|
|||
|
522689977f
|
|||
| 5c8f734acc | |||
|
380b9ad81a
|
|||
|
79d7c5a7ee
|
5
.gitea/default_merge_message/MERGE_TEMPLATE.md
Normal file
5
.gitea/default_merge_message/MERGE_TEMPLATE.md
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
chore(pr): ${PullRequestTitle} ${PullRequestReference}
|
||||||
|
|
||||||
|
${PullRequestDescription}
|
||||||
|
|
||||||
|
Merged from ${HeadBranch} into ${BaseBranch}
|
||||||
@@ -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@main
|
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"
|
||||||
|
|||||||
115
CHANGELOG.md
115
CHANGELOG.md
@@ -2,6 +2,121 @@
|
|||||||
|
|
||||||
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.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
|
||||||
|
|
||||||
|
### ⚙️ 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
|
||||||
|
|
||||||
|
- *(script)* Enhance git-cliff installer with jq support - ([5226899](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/522689977fe8883975e68add1b0cba2e685978ee))
|
||||||
|
|
||||||
|
### ⚙️ Miscellaneous Tasks
|
||||||
|
|
||||||
|
- *(workflows)* Update release action version - ([79d7c5a](https://git.0xmax42.io/actions/auto-changelog-release-action/commit/79d7c5a7eefda51f03a9bde0e933689c29d57567))
|
||||||
|
|
||||||
## [0.2.3](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.2.2..v0.2.3) - 2025-06-14
|
## [0.2.3](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v0.2.2..v0.2.3) - 2025-06-14
|
||||||
|
|
||||||
### 🐛 Bug Fixes
|
### 🐛 Bug Fixes
|
||||||
|
|||||||
46
TODO.md
Normal file
46
TODO.md
Normal 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](...))
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
34
action.yml
34
action.yml
@@ -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,34 +29,48 @@ 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: |
|
||||||
bash ${{ github.action_path }}/scripts/detect-version-change.sh
|
${{ github.action_path }}/scripts/detect-version-change.sh
|
||||||
|
|
||||||
- name: Read CLIFF_VERSION
|
- name: Read CLIFF_VERSION
|
||||||
shell: bash
|
shell: bash
|
||||||
id: cliff_version
|
id: cliff_version
|
||||||
run: bash ${{ github.action_path }}/scripts/read-cliff-version.sh
|
run: |
|
||||||
|
${{ github.action_path }}/scripts/read-cliff-version.sh
|
||||||
|
|
||||||
|
- name: Generate git-cliff config
|
||||||
|
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: |
|
||||||
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
|
- name: Set up git
|
||||||
shell: bash
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
bash ${{ github.action_path }}/scripts/setup-git.sh \
|
${{ github.action_path }}/scripts/setup-git.sh \
|
||||||
"${{ inputs.author_name }}" \
|
"${{ inputs.author_name }}" \
|
||||||
"${{ 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: bash ${{ github.action_path }}/scripts/generate-unreleased-changelog.sh
|
run: |
|
||||||
|
${{ 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 || '' }}
|
||||||
run: bash ${{ github.action_path }}/scripts/release-from-version.sh
|
run: |
|
||||||
|
${{ github.action_path }}/scripts/release-from-version.sh
|
||||||
|
|||||||
35
cliff.toml
35
cliff.toml
@@ -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
120
cliff.toml.template
Normal 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
72
scripts/augment_context.py
Executable 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)
|
||||||
@@ -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
|
||||||
|
|||||||
15
scripts/generate-git-cliff-config.sh
Executable file
15
scripts/generate-git-cliff-config.sh
Executable 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 "${GITHUB_ACTION_PATH:-${github_action_path:-${{ github.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
|
||||||
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) ===
|
# === 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
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ INSTALL_DIR="/usr/local/bin"
|
|||||||
VERSION="${1:-latest}"
|
VERSION="${1:-latest}"
|
||||||
|
|
||||||
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 curl; need tar; need grep; need sed; need awk; need jq
|
||||||
|
|
||||||
# 1 Determine version → Fetch release JSON
|
# 1 Determine version → Fetch release JSON
|
||||||
if [[ "$VERSION" == "latest" ]]; then
|
if [[ "$VERSION" == "latest" ]]; then
|
||||||
@@ -20,15 +20,23 @@ else
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
echo "🔍 Fetching release info ($API_URL)…"
|
echo "🔍 Fetching release info ($API_URL)…"
|
||||||
JSON=$(curl -sL "$API_URL")
|
JSON=$(curl -fsSL "$API_URL") || {
|
||||||
|
echo "❌ Failed to fetch release info"
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
VERSION=$(echo "$JSON" | grep -m1 '"tag_name":' | sed -E 's/.*"v?([^\"]+)".*/\1/')
|
VERSION=$(jq -r '.tag_name' <<< "$JSON") || {
|
||||||
ASSET_URL=$(echo "$JSON" |
|
echo "❌ Could not extract version"
|
||||||
grep -Eo '"browser_download_url": *"[^"]+' |
|
exit 1
|
||||||
cut -d'"' -f4 |
|
}
|
||||||
|
|
||||||
|
ASSET_URL=$(jq -r '.assets[]?.browser_download_url' <<< "$JSON" |
|
||||||
grep "${ARCH_OS}\.tar" | head -n1)
|
grep "${ARCH_OS}\.tar" | head -n1)
|
||||||
|
|
||||||
[[ -z "$ASSET_URL" ]] && { echo "❌ Matching asset not found"; exit 1; }
|
if [[ -z "$ASSET_URL" ]]; then
|
||||||
|
echo "❌ Matching asset not found for architecture ${ARCH_OS}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
ASSET_FILE=$(basename "$ASSET_URL")
|
ASSET_FILE=$(basename "$ASSET_URL")
|
||||||
echo "📦 Downloading git-cliff v${VERSION} (${ASSET_FILE}) …"
|
echo "📦 Downloading git-cliff v${VERSION} (${ASSET_FILE}) …"
|
||||||
|
|||||||
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"
|
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 ===
|
||||||
|
|||||||
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