Repository navigation
Expand file tree
/
Copy pathcliff.toml
More file actions
92 lines (83 loc) · 3.32 KB
/
Copy pathcliff.toml
File metadata and controls
92 lines (83 loc) · 3.32 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
82
83
84
85
86
87
88
89
90
91
92
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration
# [remote.github]
# owner = "oxc-project"
# repo = "oxc"
# https://git-cliff.org/docs/configuration/bump
[bump]
features_always_bump_minor = false
breaking_always_bump_major = false
[changelog]
header = """
# Changelog
All notable changes to this package will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0).\n
"""
footer = ""
# remove the leading and trailing whitespace from the templates
trim = true
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
body = """
{%- macro print_commit(commit) -%}
- {{ commit.id | truncate(length=7, end="") }} \
{% if commit.scope %}{{ commit.scope }}: {% endif %}\
{% if commit.breaking %}[**BREAKING**] {% endif %}\
{{ commit.message | trim | upper_first }}\
{% if commit.author.name %} ({{ commit.author.name }}){% endif %}\
{% raw %}\n{% endraw -%}
{%- endmacro -%}
{%- if version -%}
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}{% raw %}\n\n{% endraw -%}
{%- else -%}
## [Unreleased]{% raw %}\n\n{% endraw -%}
{%- endif -%}
{%- if commits | filter(attribute="breaking", value=true) | length != 0 -%}
### 💥 BREAKING CHANGES{% raw %}\n\n{% endraw -%}
{%- for commit in commits | filter(attribute="breaking", value=true) -%}
{{ self::print_commit(commit=commit) }}
{%- endfor -%}\
{% raw %}\n{% endraw -%}
{%- endif -%}
{%- for group, commits in commits | filter(attribute="breaking", value=false) | sort(attribute="group") | group_by(attribute="group") -%}
{%- if commits | length != 0 -%}
### {{ group | striptags | trim | upper_first }}{% raw %}\n\n{% endraw -%}
{%- for commit in commits -%}
{{ self::print_commit(commit=commit) }}
{%- endfor -%}
{% raw %}\n{% endraw -%}
{%- endif -%}
{%- endfor -%}
"""
[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = true
# filter out the commits that are not conventional
filter_unconventional = true
# Require all commits to be conventional.
# Takes precedence over filter_unconventional.
require_conventional = false
# process each line of a commit as an individual commit
split_commits = false
# protect breaking changes from being skipped due to matching a skipping commit_parser
protect_breaking_commits = false
# filter out the commits that are not matched by commit parsers
filter_commits = false
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "newest"
# regex for parsing and grouping commits
commit_parsers = [
{ message = "^feat", group = "<!-- 0 -->🚀 Features" },
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
{ message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
{ message = "^doc", group = "<!-- 3 -->📚 Documentation" },
{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },
{ message = "^style", group = "<!-- 5 -->🎨 Styling" },
{ message = "^test", group = "<!-- 6 -->🧪 Testing" },
{ message = "^chore|^ci", skip = true },
{ body = ".*security", group = "<!-- 7 -->🛡️ Security" },
{ message = "^revert", group = "<!-- 8 -->◀️ Revert" },
{ message = ".*", group = "<!-- 10 -->💼 Other" },
]