127 lines
4.8 KiB
TOML
127 lines
4.8 KiB
TOML
# 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.
|
|
|
|
[changelog]
|
|
# changelog header
|
|
header = """
|
|
# Changelog\n
|
|
"""
|
|
# template for the changelog body
|
|
# https://keats.github.io/tera/docs/#introduction
|
|
body = """
|
|
---
|
|
{% if version %}\
|
|
{% if previous.version %}\
|
|
## [{{ version | trim_start_matches(pat="v") }}]($REPO/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 }}
|
|
|
|
{% for commit in commits
|
|
| filter(attribute="scope")
|
|
| sort(attribute="scope") -%}
|
|
{% if commit.scope -%}
|
|
- {{self::commit(commit=commit)}}\
|
|
{% endif -%}
|
|
{% endfor -%}
|
|
{% for commit in commits -%}
|
|
{% if commit.scope -%}
|
|
{% else -%}
|
|
- {{self::commit(commit=commit)}}\
|
|
{% endif -%}
|
|
{% endfor -%}
|
|
{% endfor %}
|
|
{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 -%}
|
|
### New Contributors
|
|
{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) %}
|
|
* @{{ contributor.username }} made their first contribution
|
|
{%- if contributor.pr_number %} in \
|
|
[#{{ contributor.pr_number }}]($REPO/pull/{{ contributor.pr_number }})\
|
|
{% endif %}\
|
|
{% endfor %}
|
|
|
|
{% endif -%}
|
|
{% macro commit(commit) -%}
|
|
{% if commit.scope %}**({{commit.scope}})** {% endif -%}
|
|
{% if commit.breaking %}**breaking** {% endif -%}
|
|
{{ commit.message | split(pat="\n") | first | trim }} by \
|
|
{% if commit.github.username %}[@{{commit.github.username}}](https://github.com/{{commit.github.username}})\
|
|
{% else %}{{commit.author.name}}{% endif %} in \
|
|
{% if commit.github.pr_number %}[#{{ commit.github.pr_number }}]($REPO/pull/{{ commit.github.pr_number }})\
|
|
{% else %}[{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})\
|
|
{%- endif %}
|
|
{% endmacro commit -%}
|
|
"""
|
|
# template for the changelog footer
|
|
footer = """
|
|
<!-- generated by git-cliff -->
|
|
"""
|
|
# remove the leading and trailing whitespace from the template
|
|
trim = true
|
|
postprocessors = [
|
|
{ pattern = '\$REPO', replace = "https://github.com/jdx/mise-action" },
|
|
]
|
|
|
|
[git]
|
|
# parse the commits based on https://www.conventionalcommits.org
|
|
conventional_commits = true
|
|
# filter out the commits that are not conventional
|
|
filter_unconventional = false
|
|
# process each line of a commit as an individual commit
|
|
split_commits = false
|
|
# regex for preprocessing the commit messages
|
|
commit_preprocessors = [
|
|
# remove issue numbers from commits
|
|
#{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
|
|
# 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 = '^(chore|fix)\(deps.*\):', skip = true },
|
|
{ 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\(release\): prepare for', skip = true },
|
|
{ message = '^chore\(pr\)', skip = true },
|
|
{ message = '^chore\(pull\)', skip = true },
|
|
{ message = '^chore: Release mise-action', skip = true },
|
|
{ message = '^chore|^ci', group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
|
|
{ body = '.*security', group = "<!-- 8 -->🛡️ Security" },
|
|
{ message = '^revert', group = "<!-- 9 -->◀️ Revert" },
|
|
{ message = '.', group = "<!-- 11 -->🔍 Other Changes" },
|
|
]
|
|
# protect breaking changes from being skipped due to matching a skipping commit_parser
|
|
protect_breaking_commits = false
|
|
# filter out the commits that are not matched by commit parsers
|
|
filter_commits = false
|
|
# regex for matching git tags
|
|
tag_pattern = '^v\d+\.\d+\.\d+$'
|
|
# regex for skipping tags
|
|
#skip_tags = '^v(1|2023|2024\.0)\.'
|
|
# regex for ignoring tags
|
|
# ignore_tags = ""
|
|
# sort the tags topologically
|
|
topo_order = false
|
|
# sort the commits inside sections by oldest/newest order
|
|
sort_commits = "oldest"
|
|
# limit the number of commits included in the changelog.
|
|
# limit_commits = 42
|
|
|
|
[remote.github]
|
|
owner = "jdx"
|
|
repo = "mise-action"
|