Repository navigation
Expand file tree
/
Copy pathcliff.toml
More file actions
53 lines (47 loc) · 1.75 KB
/
Copy pathcliff.toml
File metadata and controls
53 lines (47 loc) · 1.75 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
# git-cliff configuration — renders CHANGELOG.md from conventional commits
# (regenerated by `scripts/release.sh`; do not hand-edit CHANGELOG.md).
# Group names follow Keep a Changelog; release commit and version tags are
# handled by release.sh.
[changelog]
header = """
# Changelog
All notable changes to this project are documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
"""
body = """
## {{ version }} - {{ timestamp | date(format="%Y-%m-%d") }}
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group }}
{% for commit in commits %}
- {{ commit.message | split(pat="\n") | first | upper_first }}
{%- endfor %}
{%- endfor %}
"""
footer = """
<!-- generated by git-cliff -->
"""
trim = true
[git]
conventional_commits = true
filter_unconventional = false
split_commits = false
protect_breaking_commits = true
tag_pattern = "v[0-9].*"
commit_parsers = [
{ message = "^feat", group = "Added" },
{ message = "^fix", group = "Fixed" },
{ message = "^perf", group = "Changed" },
{ message = "^refactor", group = "Changed" },
{ message = "^doc", group = "Documentation" },
{ message = "^test", group = "Testing" },
# The release commit itself must not appear in the changelog.
{ message = "^chore\\(release", skip = true },
# Merge commits carry no user-facing change of their own.
{ message = "^Merge (pull request|branch)", skip = true },
{ message = "^chore", group = "Miscellaneous" },
{ message = "^build", group = "Miscellaneous" },
{ message = "^ci", group = "Miscellaneous" },
# Fallback for non-conventional subjects (e.g. milestone squashes).
{ message = ".*", group = "Other" },
]