fanferro/cliff.toml at main · kalaspuff/fanferro · GitHub

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
# git-cliff configuration: changelog and release notes from conventional commits.
# https://git-cliff.org/docs/configuration

[changelog]
header = ""
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 | striptags | trim | upper_first }}
{% for commit in commits %}
- {% if commit.scope %}**{{ commit.scope }}:** {% endif %}\
{% if commit.breaking %}[**breaking**] {% endif %}\
{{ commit.message | upper_first }}\
{% if commit.remote.pr_number %} (#{{ commit.remote.pr_number }}){% endif %}\
{% endfor %}
{% endfor %}
"""
footer = ""
trim = true

[git]
conventional_commits = true
filter_unconventional = true
split_commits = false
protect_breaking_commits = true
filter_commits = false
tag_pattern = "v[0-9]+\\.[0-9]+\\.[0-9]+"
sort_commits = "oldest"
commit_parsers = [
    { message = "^chore\\(release\\)", skip = true },
    { message = "^(chore|build|ci)\\(deps\\)", skip = true },
    { message = "^feat", group = "<!-- 0 -->Features" },
    { message = "^fix", group = "<!-- 1 -->Bug fixes" },
    { message = "^perf", group = "<!-- 2 -->Performance" },
    { message = "^refactor", group = "<!-- 3 -->Refactoring" },
    { message = "^docs", group = "<!-- 4 -->Documentation" },
    { message = "^test", group = "<!-- 5 -->Tests" },
    { message = "^(ci|build)", group = "<!-- 6 -->Build and CI" },
    { message = "^revert", group = "<!-- 7 -->Reverts" },
    { message = "^chore", group = "<!-- 8 -->Miscellaneous" },
]