Repository navigation
Expand file tree
/
Copy pathcliff.toml
More file actions
79 lines (76 loc) · 2.95 KB
/
Copy pathcliff.toml
File metadata and controls
79 lines (76 loc) · 2.95 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
# configuration file for git-cliff (0.1.0)
[changelog]
# changelog header
header = """
# Changelog
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 }}\
{% else %}\
## unreleased\
{% endif %}
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | striptags | trim | upper_first }}
{% for commit in commits | filter(attribute="scope") | sort(attribute="scope") %}
- **{{commit.scope}}:** {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }})\
{%- if commit.links %}{% for link in commit.links %} - [{{link.text}}]({{link.href}}){% endfor -%}{% endif %}\
)
{%- if commit.breaking %}
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))
{%- endif -%}
{%- endfor -%}
{%- for commit in commits %}
{%- if commit.scope -%}
{% else -%}
- *(No Category)* {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))
{% if commit.breaking -%}
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))
{% endif -%}
{% endif -%}
{% endfor -%}
{% raw %}\n{% endraw %}\
{% endfor %}\n
"""
# remove the leading and trailing whitespaces from the template
trim = true
# changelog footer
footer = """
<!-- generated by git-cliff -->
"""
[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 = "<!-- 0 -->Features"},
{ message = "^fix", group = "<!-- 1 -->Bug Fixes"},
{ message = "^perf", group = "<!-- 2 -->Performance"},
{ message = "^refactor", group = "<!-- 3 -->Refactor"},
{ message = "^doc", group = "<!-- 4 -->Documentation"},
{ message = "^style", group = "Styling", skip = true},
{ message = "^test", group = "<!-- 5 -->Testing"},
{ message = "^chore\\(release\\):", skip = true},
{ message = "^chore", group = "Miscellaneous Tasks", skip = true},
{ body = ".*security", group = "<!-- 6 -->Security"},
]
# filter out the commits that are not matched by commit parsers
filter_commits = false
# glob pattern for matching git tags
tag_pattern = "20[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"
link_parsers = [
{ pattern = "#(\\d+)", href = "https://gitlab.com/davinkevin.fr/podcast-server/-/issues/$1"}
]