summaryrefslogtreecommitdiff
path: root/cliff.toml
blob: 2ec492c44e4483e6cdda323b36394be89de6d1e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
[changelog]
header = "# Changelog\n\n"
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 | sort(attribute="message") %}
		- {% set component = commit.footers | filter(attribute="token", value="Component") | map(attribute="value") | join(sep=", ") %}
		{%- if component %}{{ component }}: {% elif commit.scope %}{{ commit.scope }}: {% endif %}
		{{- commit.message | upper_first }}
		{%- if commit.breaking %} (breaking){% endif %}
		{%- set fixes = commit.footers | filter(attribute="token", value="Fixes") %}
		{%- for fix in fixes %}{% if fix.separator|trim == '#' %}{{ fix.separator }}{{ fix.value }}{% endif %}{% endfor %}
    {%- endfor %}
{% endfor %}

"""
footer = ""

# remove the leading and trailing whitespaces from the template
trim = true

[git]
# allow only conventional commits
# https://www.conventionalcommits.org
conventional_commits = true
# regex for parsing and grouping commits
commit_parsers = [
    { message = "^chore\\(release\\): version", skip = true},
    { message = "^feat", group = "Features"},
    { message = "^fix", group = "Bug Fixes"},
    { message = "^doc", group = "Documentation"},
    { message = "^perf", group = "Performance"},
    { message = "^test", group = "Testing"},
    { message = "^chore", group = "Miscellaneous Tasks"},
    { body = ".*security", group = "Security"},
]
# filter out the commits that are not matched by commit parsers
filter_commits = false
# regex for matching git tags
tag_pattern = "^v[0-9]+\\.[0-9]+\\.[0-9]+.*"