diff --git a/action.yml b/action.yml index 6afbbe1..ab24bb8 100644 --- a/action.yml +++ b/action.yml @@ -39,6 +39,11 @@ runs: 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 shell: bash run: | diff --git a/cliff.toml.template b/cliff.toml.template new file mode 100644 index 0000000..dd1624d --- /dev/null +++ b/cliff.toml.template @@ -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 = '', 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() -%} + /{{ 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}](/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 = "๐Ÿš€ Features" }, + { message = "^fix", group = "๐Ÿ› Bug Fixes" }, + { message = "^doc", group = "๐Ÿ“š Documentation" }, + { message = "^perf", group = "โšก Performance" }, + { message = "^refactor", group = "๐Ÿšœ Refactor" }, + { message = "^style", group = "๐ŸŽจ Styling" }, + { message = "^test", group = "๐Ÿงช 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 = "โš™๏ธ Miscellaneous Tasks" }, + { body = ".*security", group = "๐Ÿ›ก๏ธ Security" }, + { message = "^revert", group = "โ—€๏ธ Revert" }, + { message = ".*", group = "๐Ÿ’ผ 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" diff --git a/scripts/generate-git-cliff-config.sh b/scripts/generate-git-cliff-config.sh new file mode 100755 index 0000000..6dc0f3c --- /dev/null +++ b/scripts/generate-git-cliff-config.sh @@ -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 \ No newline at end of file