stdnum/cliff.toml at main · stella/stdnum · GitHub

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
# git-cliff configuration: https://git-cliff.org/docs/configuration
#
# Generates GitHub release notes from Conventional Commits since the
# previous release tag.

[changelog]
header = ""
body = """
{% if version %}\
{% 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 | trim }}\
{% endfor %}
{% endfor %}\n
"""
footer = ""
trim = true
postprocessors = [
  { pattern = "\\(#([0-9]+)\\)", replace = "([#${1}](https://github.com/stella/stdnum/pull/${1}))" },
]

[git]
conventional_commits = true
filter_unconventional = true
split_commits = false
filter_commits = false
protect_breaking_commits = true
tag_pattern = "^v[0-9]+\\.[0-9]+\\.[0-9]+(-(rc|beta|alpha)\\.[0-9]+)?$"
sort_commits = "newest"

# Order matters: first matching parser wins.
commit_parsers = [
  { message = "^\\w+(\\([^)]+\\))?!", group = "<!-- 0 -->Breaking Changes" },
  { footer = "BREAKING CHANGE", group = "<!-- 0 -->Breaking Changes" },
  { message = "^feat", group = "<!-- 1 -->Features" },
  { message = "^fix", group = "<!-- 2 -->Bug Fixes" },
  { message = "^perf", group = "<!-- 3 -->Performance" },
  { message = "^refactor", group = "<!-- 4 -->Refactor" },
  { message = "^docs", group = "<!-- 5 -->Documentation" },
  { message = "^test", group = "<!-- 6 -->Tests" },
  { message = "^chore\\(deps\\)", group = "<!-- 7 -->Dependencies" },
  { message = "^chore", group = "<!-- 8 -->Miscellaneous" },
  { message = "^style", skip = true },
  { message = "^ci", skip = true },
  { message = "^build", skip = true },
  { message = "^revert", group = "<!-- 9 -->Reverts" },
]