-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathcliff.toml
More file actions
52 lines (50 loc) · 1.85 KB
/
cliff.toml
File metadata and controls
52 lines (50 loc) · 1.85 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
# git-cliff configuration
# https://git-cliff.org
# Note: GITHUB_REPO env var is set by GitHub Actions. When running locally,
# PR links will show "OWNER/REPO" placeholder - this is expected.
[changelog]
header = """
# Changelog\n
All notable changes to this project will be documented in this file.\n
"""
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 %}
{%- set msg = commit.message | upper_first -%}
{%- set pr_in_msg = msg is containing("(#" ) -%}
- {% if commit.scope %}**{{ commit.scope }}:** {% endif %}\
{{ msg }}\
{% if commit.remote.pr_number and not pr_in_msg %} ([#{{ commit.remote.pr_number }}](https://github.com/{{ get_env(name="GITHUB_REPO", default="OWNER/REPO") }}/pull/{{ commit.remote.pr_number }})){% endif %}\
{% endfor %}
{% endfor %}
"""
footer = ""
trim = true
postprocessors = []
[git]
conventional_commits = true
filter_unconventional = true
split_commits = false
commit_parsers = [
{ message = "^feat", group = "Features" },
{ message = "^fix", group = "Bug Fixes" },
{ message = "^docs?", group = "Documentation" },
{ message = "^perf", group = "Performance" },
{ message = "^refactor", group = "Refactor" },
{ message = "^style", group = "Styling" },
{ message = "^test", group = "Testing" },
{ message = "^chore\\(release\\)", skip = true },
{ message = "^chore\\(deps.*\\)", skip = true },
{ message = "^chore|^ci", group = "Miscellaneous Tasks" },
{ body = ".*security", group = "Security" },
]
protect_breaking_commits = false
filter_commits = false
topo_order = false
sort_commits = "oldest"