-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathcliff.toml
More file actions
67 lines (62 loc) · 2.65 KB
/
cliff.toml
File metadata and controls
67 lines (62 loc) · 2.65 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
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration
[remote.github]
owner = "NextStd"
repo = "nextstd"
[changelog]
# A Tera template to be rendered for each release in the changelog.
# See https://keats.github.io/tera/docs/#introduction
body = """
{% if version %}
## {{ version }} - {{ 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 %}
- {% if commit.scope %}**({{ commit.scope }})** {% endif %}{{ commit.message | upper_first | trim }}
{% endfor %}
{% endfor %}
"""
# Remove leading and trailing whitespaces from the changelog's body.
trim = true
# A Tera template to be rendered as the changelog's footer.
# See https://keats.github.io/tera/docs/#introduction
footer = """
<!-- generated by git-cliff -->
"""
# An array of regex based postprocessors to modify the changelog.
# Replace the placeholder `<REPO>` with a URL.
postprocessors = []
[git]
# Parse commits according to the conventional commits specification.
# See https://www.conventionalcommits.org
conventional_commits = true
# Exclude commits that do not match the conventional commits specification.
filter_unconventional = false
# Split commits on newlines, treating each line as an individual commit.
split_commits = false
commit_parsers = [
{ message = "^feat", group = "<!-- 0 -->:rocket: New features" },
{ message = "^fix", group = "<!-- 1 -->:bug: Bug fixes" },
{ message = "^docs", group = "<!-- 2 -->:page_facing_up: Documentation" },
{ message = "^perf", group = "<!-- 3 -->:zap: Performance" },
{ message = "^chore", group = "<!-- 4 -->:wrench: Miscellaneous" },
{ message = "^refactor", group = "<!-- 5 -->:recycle: Refactoring" },
{ message = "^style", group = "<!-- 6 -->:art: Styling" },
{ message = "^test", group = "<!-- 7 -->:white_check_mark: Testing" },
{ message = "^Merge", group = "<!-- 8 -->:twisted_rightwards_arrows: Pull Requests" },
{ message = "^build", group = "<!-- 9 -->:hammer: Build" },
{ message = "^ci", group = "<!-- 10 -->:construction_worker: CI" },
{ message = ".*", group = "<!-- 11 -->:package: Other" },
]
# An array of regex based parsers to modify commit messages prior to further processing.
commit_preprocessors = [{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" }]
# Exclude commits that are not matched by any commit parser.
filter_commits = false
# Order releases topologically instead of chronologically.
topo_order = false
# Order of commits in each group/release within the changelog.
# Allowed values: newest, oldest
sort_commits = "newest"