-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcliff.toml
More file actions
46 lines (44 loc) · 1.86 KB
/
Copy pathcliff.toml
File metadata and controls
46 lines (44 loc) · 1.86 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
# git-cliff configuration (https://git-cliff.org) — release notes from the
# Conventional Commits history. Used by `mise run changelog`, dev/release.sh
# (preview) and .github/workflows/release.yml (GitHub release body).
#
# No [remote.github]: the repo is private, so PR/username enrichment would add
# an API-token dependency for links most readers can't follow anyway. Short
# commit hashes stay clickable in the GitHub release UI for authorized viewers.
[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 }}
{% for commit in commits %}
- {% if commit.scope %}**{{ commit.scope }}:** {% endif %}{{ commit.message | split(pat="\n") | first | upper_first }} ({{ commit.id | truncate(length=8, end="") }})\
{% endfor %}
{% endfor %}
"""
trim = true
[git]
conventional_commits = true
# Keep the handful of pre-convention commits — the catch-all parser files them
# under Miscellaneous instead of dropping them from the notes.
filter_unconventional = false
tag_pattern = "v[0-9]*"
protect_breaking_commits = true
sort_commits = "oldest"
commit_parsers = [
{ message = "^chore\\(release\\)", 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 = "^style", group = "<!-- 5 -->Styling" },
{ message = "^test", group = "<!-- 6 -->Testing" },
{ message = "^build", group = "<!-- 7 -->Build" },
{ message = "^ci", group = "<!-- 8 -->CI" },
{ message = ".*", group = "<!-- 9 -->Miscellaneous" },
]