mirror of
https://github.com/orhun/git-cliff.git
synced 2024-11-25 12:52:49 +03:00
73 lines
2.4 KiB
TOML
73 lines
2.4 KiB
TOML
# git-cliff ~ configuration file
|
|
# https://git-cliff.org/docs/configuration
|
|
|
|
[changelog]
|
|
# template for the changelog header
|
|
header = """
|
|
# Changelog\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 = """
|
|
{% 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 | upper_first }}
|
|
{% for commit in commits
|
|
| filter(attribute="scope")
|
|
| sort(attribute="scope") %}
|
|
- *({{commit.scope}})* {{ commit.message | upper_first }}
|
|
{%- if commit.breaking %}
|
|
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
|
|
{%- endif -%}
|
|
{%- endfor -%}
|
|
{% raw %}\n{% endraw %}\
|
|
{%- for commit in commits %}
|
|
{%- if commit.scope -%}
|
|
{% else -%}
|
|
- *(No Category)* {{ commit.message | upper_first }}
|
|
{% if commit.breaking -%}
|
|
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
|
|
{% endif -%}
|
|
{% endif -%}
|
|
{% endfor -%}
|
|
{% raw %}\n{% endraw %}\
|
|
{% endfor %}\n
|
|
"""
|
|
# template for the changelog footer
|
|
footer = """
|
|
<!-- generated by git-cliff -->
|
|
"""
|
|
# remove the leading and trailing whitespace from the templates
|
|
trim = true
|
|
|
|
|
|
[git]
|
|
# parse the commits based on https://www.conventionalcommits.org
|
|
conventional_commits = true
|
|
# filter out the commits that are not conventional
|
|
filter_unconventional = true
|
|
# 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\\(release\\): prepare for", skip = true },
|
|
{ message = "^chore", group = "Miscellaneous Tasks" },
|
|
{ body = ".*security", group = "Security" },
|
|
]
|
|
# 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 = "oldest"
|