mirror of
https://github.com/lotabout/skim.git
synced 2026-09-10 07:16:23 -04:00
121 lines
4.9 KiB
TOML
121 lines
4.9 KiB
TOML
# git-cliff ~ configuration file
|
|
# https://git-cliff.org/docs/configuration
|
|
|
|
|
|
[changelog]
|
|
# A Tera template to be rendered for each release in the changelog.
|
|
# See https://keats.github.io/tera/docs/#introduction
|
|
body = """
|
|
{%- macro remote_url() -%}
|
|
https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
|
|
{%- endmacro -%}
|
|
|
|
{% if version %}\
|
|
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
|
|
{% else %}\
|
|
## [unreleased]
|
|
{% endif %}\
|
|
{% for group, commits in commits | group_by(attribute="group") %}
|
|
### {{ group | striptags | trim | upper_first }}
|
|
{% for commit in commits %}
|
|
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
|
|
{% if commit.breaking %}[**breaking**] {% endif %}\
|
|
{{ commit.message | upper_first }}\
|
|
{% endfor %}
|
|
{% endfor %}
|
|
|
|
{%- if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
|
|
### New Contributors
|
|
{%- endif -%}
|
|
|
|
{% 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 }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}) \
|
|
{%- endif %}
|
|
{%- endfor %}\n
|
|
|
|
{%- if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}{% raw %}\n{% endraw -%}{% endif %}
|
|
|
|
"""
|
|
header = """
|
|
# Changelog
|
|
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
"""
|
|
# Remove leading and trailing whitespaces from the changelog's body.
|
|
footer = "<!-- generated by git-cliff -->"
|
|
trim = true
|
|
# Render body even when there are no releases to process.
|
|
render_always = true
|
|
# An array of regex based postprocessors to modify the changelog.
|
|
postprocessors = [
|
|
# Replace the placeholder <REPO> with a URL.
|
|
#{ pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" },
|
|
]
|
|
# render body even when there are no releases to process
|
|
# render_always = true
|
|
# output file path
|
|
# output = "test.md"
|
|
|
|
[git]
|
|
# Parse commits according to the conventional commits specification.
|
|
# See https://www.conventionalcommits.org
|
|
conventional_commits = true
|
|
# Exclude commits that do not match the conventional commits specification.
|
|
filter_unconventional = true
|
|
# Require all commits to be conventional.
|
|
# Takes precedence over filter_unconventional.
|
|
require_conventional = false
|
|
# Split commits on newlines, treating each line as an individual commit.
|
|
split_commits = false
|
|
# An array of regex based parsers to modify commit messages prior to further processing.
|
|
commit_preprocessors = [
|
|
# Allow commits named `type!(scope): desc` and treat them like `type(scope)!: desc`
|
|
{ pattern = '(.*)!\((.*)\):(.*)', replace = "$1($2)!:$3" },
|
|
]
|
|
# Prevent commits that are breaking from being excluded by commit parsers.
|
|
protect_breaking_commits = false
|
|
# An array of regex based parsers for extracting data from the commit message.
|
|
# Assigns commits to groups.
|
|
# Optionally sets the commit's scope and can decide to exclude commits from further processing.
|
|
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\\(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 = "^release", skip = true },
|
|
{ message = ".*", group = "<!-- 10 -->💼 Other" },
|
|
]
|
|
# Exclude commits that are not matched by any commit parser.
|
|
filter_commits = false
|
|
# Fail on a commit that is not matched by any commit parser.
|
|
fail_on_unmatched_commit = false
|
|
# An array of link parsers for extracting external references, and turning them into URLs, using regex.
|
|
link_parsers = []
|
|
# Include only the tags that belong to the current branch.
|
|
use_branch_tags = false
|
|
# Order releases topologically instead of chronologically.
|
|
topo_order = false
|
|
# Order commits topologically instead of chronologically.
|
|
topo_order_commits = true
|
|
# Order of commits in each group/release within the changelog.
|
|
# Allowed values: newest, oldest
|
|
sort_commits = "oldest"
|
|
# Process submodules commits
|
|
recurse_submodules = false
|