1# configuration file for git-cliff (0.1.0)
2
3[changelog]
4# changelog header
5header = """
6# `miette` Release Changelog
7
8"""
9
10# template for the changelog body
11# https://tera.netlify.app/docs/#introduction
12body = """
13{% if version %}\
14<a name="{{ version }}"></a>
15## {{ version | replace(from="v", to="") }} ({{ timestamp | date(format="%Y-%m-%d") }})
16{% else %}\
17## Unreleased
18{% endif %}\
19{% for group, commits in commits | filter(attribute="scope") | group_by(attribute="group") %}
20### {{ group | upper_first }}
21{% for commit in commits %}
22{% if commit.scope %}\
23* **{{ commit.scope }}:** {{ commit.message }} ([{{ commit.id | truncate(length=8, end="") }}](https://github.com/zkat/miette/commit/{{ commit.id }}))
24{%- if commit.breaking %}
25    * **BREAKING CHANGE**: {{ commit.breaking_description }}
26{%- endif %}\
27{% endif %}\
28{% endfor %}
29{% endfor %}
30"""
31
32# remove the leading and trailing whitespace from the template
33trim = false
34
35# changelog footer
36# footer = """
37# <!-- generated by git-cliff -->
38# """
39
40[git]
41# allow only conventional commits
42# https://www.conventionalcommits.org
43conventional_commits = true
44# regex for parsing and grouping commits
45commit_parsers = [
46    { message = "^feat*", group = "Features"},
47    { message = "^fix*", group = "Bug Fixes"},
48    { message = "^doc*", group = "Documentation"},
49    { message = "^perf*", group = "Performance"},
50    { message = "^refactor*", group = "Refactor"},
51    { message = "^style*", group = "Styling"},
52    { message = "^test*", group = "Testing"},
53    { message = "^chore\\(release\\): prepare for*", skip = true},
54    { message = "^chore*", group = "Miscellaneous Tasks"},
55    { body = ".*security", group = "Security"},
56]
57# filter out the commits that are not matched by commit parsers
58filter_commits = true
59# glob pattern for matching git tags
60# tag_pattern = "v?[0-9]*"
61# regex for skipping tags
62# skip_tags = "v0.1.0-beta.1"
63