kb/cliff.toml at main · compozy/kb · 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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration

[changelog]
header = """
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [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 | upper_first }}
{% for commit in commits -%}
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}{{ commit.message | upper_first }}
{% if commit.breaking -%}
  - **BREAKING:** {{ commit.breaking_description }}
{% endif -%}
{% endfor %}
{% if not loop.last %}

{% endif -%}
{% endfor -%}
"""

footer = """
{% for release in releases -%}
    {% if release.version -%}
        {% if release.previous.version -%}
            [{{ release.version | trim_start_matches(pat="v") }}]: https://github.com/compozy/kb/compare/{{ release.previous.version }}...{{ release.version }}
        {% endif -%}
    {% endif -%}
{% endfor -%}

---
*Generated by [git-cliff](https://git-cliff.org)*
"""

trim = true

postprocessors = [
  { pattern = '<REPO>', replace = "https://github.com/compozy/kb" }
]

[git]
conventional_commits = true
filter_unconventional = true
split_commits = false

commit_preprocessors = [
  { pattern = '  +', replace = " "},
  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/compozy/kb/issues/${2}))" },
]

commit_parsers = [
  { message = "^feat", group = "🎉 Features" },
  { message = "^feature", group = "🎉 Features" },
  { message = "^fix", group = "🐛 Bug Fixes" },
  { message = "^bugfix", group = "🐛 Bug Fixes" },
  { message = "^perf", group = "⚡ Performance Improvements" },
  { message = "^security", group = "🔒 Security" },
  { message = "^docs", group = "📚 Documentation" },
  { message = "^build", group = "📦 Build System" },
  { message = "^ci", group = "🔧 CI/CD" },
  { message = "^refactor", group = "♻️ Refactoring" },
  { message = "^test", group = "🧪 Testing" },
  { message = "^deps", group = "📦 Dependencies" },
  { message = "^chore\\(deps\\)", group = "📦 Dependencies" },
  { message = "^style", group = "💅 Style" },
  { message = "^chore\\(release\\):", skip = true },
  { message = "^chore", group = "🔧 Miscellaneous Tasks" },
  { message = "^revert", group = "⏪ Reverts" },
  { message = "^Merge branch", skip = true },
  { message = "^Merge pull request", skip = true },
  { message = "^Merge remote-tracking branch", skip = true },
  { message = "^wip", skip = true },
  { message = "^WIP", skip = true },
  { message = ".*", group = "🔄 Other Changes" },
]

protect_breaking_commits = true
filter_commits = false
tag_pattern = "v[0-9].*"
sort_commits = "oldest"

[bump]
features_always_bump_minor = false
breaking_always_bump_major = false
initial_tag = "v0.0.1"
custom_major_increment_regex = "MAJOR|BREAKING[- ]CHANGE"
custom_minor_increment_regex = "feat|feature|MINOR"