Compare commits
17 Commits
d8bf0743f7
...
v1
| Author | SHA1 | Date | |
|---|---|---|---|
| 7246f2f4d8 | |||
|
2cfe12debc
|
|||
| a24d031052 | |||
|
064677870b
|
|||
| f6713d9d6d | |||
|
81c4ef4913
|
|||
| 867a5f3c6b | |||
|
e050996fd4
|
|||
| 10d16c4858 | |||
|
f7473a5198
|
|||
| 2e4bbd7091 | |||
|
ce5cb7bcc0
|
|||
| 454c5370df | |||
|
437fd0cdd0
|
|||
| 2f224733f4 | |||
|
096ecb5822
|
|||
| 2a4931f295 |
29
CHANGELOG.md
29
CHANGELOG.md
@@ -2,6 +2,35 @@
|
|||||||
|
|
||||||
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
|
## [1.1.0](https://git.0xmax42.io/actions/auto-changelog-release-action/compare/v1.0.1..v1.1.0) - 2025-09-29
|
||||||
|
|
||||||
### 🚀 Features
|
### 🚀 Features
|
||||||
|
|||||||
@@ -39,6 +39,13 @@ 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: |
|
||||||
|
|||||||
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"
|
||||||
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 "$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
|
||||||
@@ -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
|
||||||
|
|||||||
@@ -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
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user