-
Notifications
You must be signed in to change notification settings - Fork 47
Expand file tree
/
Copy pathcliff.toml
More file actions
81 lines (70 loc) · 2.81 KB
/
cliff.toml
File metadata and controls
81 lines (70 loc) · 2.81 KB
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# https://git-cliff.org/docs/configuration
[changelog]
header = """
# Changelog\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 | striptags | trim | upper_first }}
{% for commit in commits %}
* {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
{% if commit.breaking %}[**breaking**] {% endif %}\
{{ commit.message | split(pat="\n") | first | trim }}\
{% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif %}\
{% if commit.remote.pr_number %} in #{{ commit.remote.pr_number }}{%- endif %}
{% endfor %}
{% endfor %}\n
{%- if github -%}
{% if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
{% raw %}\n{% endraw -%}
## 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 -%}
{% raw %}\n{% endraw -%}
{% raw %}\n{% endraw -%}
{% raw %}\n{% endraw -%}
{%- endif -%}
{%- macro remote_url() -%}
https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
{%- endmacro -%}
"""
# remove the leading and trailing spaces
trim = true
[git]
# parse the commits based on https://www.conventionalcommits.org
# regex for parsing and grouping commits
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 = '^release', skip = true },
{ message = '^chore', group = '<!-- 7 -->⚙️ Miscellaneous Tasks' },
{ message = ".*", group = "Other Changes", default_scope = "other changes"},
]
# filter out the commits that are not matched by commit parsers
filter_commits = false
filter = { exclude = { scopes = ["ci", "infra", "ops"] } }
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "newest"
# glob pattern for matching git tags
tag_pattern = "^[0-9]+.[0-9]+.[0-9]+$"
# allow commits that don't follow the conventional commits standard
filter_unconventional = false