mirror of
https://github.com/LunarVim/LunarVim.git
synced 2024-09-20 18:45:08 +02:00
80 lines
2.7 KiB
TOML
80 lines
2.7 KiB
TOML
# configuration file for git-cliff (0.1.0)
|
|
|
|
[changelog]
|
|
# changelog header
|
|
header = """
|
|
# Changelog\n
|
|
All notable changes to this project will be documented in this file.\n
|
|
"""
|
|
# template for the changelog body
|
|
# https://tera.netlify.app/docs/#introduction
|
|
body = """
|
|
{% if version %}\
|
|
## [{{ version | trim_start_matches(pat="v") }}]
|
|
{% 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 }}
|
|
{%- if commit.breaking %}
|
|
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
|
|
{%- endif -%}
|
|
{%- endfor %}
|
|
{% for commit in commits %}
|
|
{%- if commit.scope -%}
|
|
{% else -%}
|
|
- {{ commit.message }}
|
|
{% if commit.breaking -%}
|
|
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
|
|
{% endif -%}
|
|
{% endif -%}
|
|
{% endfor -%}
|
|
{% raw %}{% endraw %}\
|
|
{% endfor %}\n
|
|
"""
|
|
# remove the leading and trailing whitespaces from the template
|
|
trim = true
|
|
# changelog footer
|
|
footer = """
|
|
<!-- generated by git-cliff -->
|
|
"""
|
|
|
|
[git]
|
|
# allow only conventional commits
|
|
# 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 = "(.*bump|.*Bump)", group = "<!-- 7 --> Miscellaneous Tasks", skip = true},
|
|
{ message = "^build", group = "<!-- 0 --> Packaging"},
|
|
{ message = "(^feat|^Feat|^\\[Feat)", group = "<!-- 1 --> Features"},
|
|
{ message = "(^bug|^Bug|^fix|^\\[Bug)", group = "<!-- 2 --> Bugfix"},
|
|
{ message = "^refactor", group = "<!-- 3 --> Refactor"},
|
|
{ message = "^doc", group = "<!-- 4 --> Documentation"},
|
|
{ message = "^revert", group = "<!-- 5 --> Revert"},
|
|
{ message = "^perf", group = "<!-- 6 --> Performance"},
|
|
{ message = "^chore", group = "<!-- 7 --> Miscellaneous Tasks", skip = true},
|
|
{ message = "^ci", group = "<!-- 7 --> Miscellaneous Tasks", skip = true},
|
|
{ message = "^test", group = "<!-- 7 --> Miscellaneous Tasks", skip = true},
|
|
]
|
|
# filter out the commits that are not matched by commit parsers
|
|
filter_commits = false
|
|
# glob pattern for matching git tags
|
|
tag_pattern = "v[0-9]*"
|
|
# regex for skipping tags
|
|
skip_tags = "v0.1.0-beta.1"
|
|
# 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"
|
|
|
|
[features]
|
|
preserve_order = ["serde_json/preserve_order"]
|