submod/cliff.toml at main · bashandbone/submod · 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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# # SPDX-FileCopyrightText: 2025 Adam Poulemanos <89049923+bashandbone@users.noreply.github.com>
#
# SPDX-License-Identifier: LicenseRef-PlainMIT OR MIT
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration

[changelog]
header = """
<!--
SPDX-FileCopyrightText: 2026 Adam Poulemanos <89049923+bashandbone@users.noreply.github.com>
SPDX-License-Identifier: LicenseRef-PlainMIT OR MIT

Git-cliff generates this file from the git commit history. The configuration for how it generates this file is in `cliff.toml`. Please edit that file, not this one.

commit hashes cause false-positives for the spellchecker:
spellchecker:off
-->
# Changelog

We document all important changes below.

Submod follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
"""
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 %}\
- {% if commit.scope %}(**{{ commit.scope }}**) {% endif %}\
{{ commit.message | upper_first }}\
([`{{ commit.id | truncate(length=7, end="") }}`](https://github.com/bashandbone/submod/commit/{{ commit.id }}))\
{% if commit.breaking %} [**breaking**]{% endif %}

{% endfor %}\
{% endfor %}\n
"""
footer = "<!-- spellchecker:on -->"
trim = true

[git]
conventional_commits = true
filter_unconventional = true
split_commits = false
commit_preprocessors = []
commit_parsers = [
  { message = "^feat", group = "Features" },
  { message = "^fix", group = "Bug Fixes" },
  { message = "^perf", group = "Performance" },
  { message = "^docs", group = "Documentation" },
  { message = "^refactor", group = "Refactoring" },
  { message = "^(ci|build)", group = "CI/Build" },
  { message = "^chore\\(release\\)", skip = true },
  { message = "^chore", group = "Miscellaneous" },
  { message = "^revert", group = "Reverts" },
  { message = "^test", group = "Testing" },
]
protect_breaking_commits = false
filter_commits = false
tag_pattern = "v[0-9]+\\.[0-9]+\\.[0-9]+"
skip_tags = ""
ignore_tags = ""
topo_order = false
sort_commits = "oldest"
link_parsers = []