rust-crate-template/cliff.toml.liquid at main · RAprogramm/rust-crate-template · 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
# SPDX-FileCopyrightText: 2025 {{author_name}} <{{author_email}}>
#
# SPDX-License-Identifier: MIT

[changelog]
header = """
<!--
SPDX-FileCopyrightText: 2025 {{author_name}} <{{author_email}}>

SPDX-License-Identifier: MIT
-->

# 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.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

"""
body = """
{% raw %}{%- macro remote_url() -%}{% endraw %}
  https://github.com/{{gh_username}}/{{project-name}}
{% raw %}{%- endmacro -%}

{% if version -%}
## [{{ version | trim_start_matches(pat="v") }}]({{ self::remote_url() }}/releases/tag/{{ version }}) — {{ timestamp | date(format="%Y-%m-%d") }}
{% else -%}
## [Unreleased]({{ self::remote_url() }}/compare/{{ previous.version }}...HEAD)
{% 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 %}\
{% if commit.breaking %}**BREAKING** {% endif %}\
{{ commit.message | upper_first }} \
([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
{% if commit.remote.username %} by [@{{ commit.remote.username }}](https://github.com/{{ commit.remote.username }}){%- endif %}\
{% if commit.remote.pr_number %} in [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}){%- endif %}
{% endfor %}
{% endfor -%}

{%- if github.contributors | filter(attribute="is_first_time", value=true) | length != 0 %}
### New Contributors

{% for contributor in github.contributors | filter(attribute="is_first_time", value=true) -%}
- [@{{ contributor.username }}](https://github.com/{{ contributor.username }}) made their first contribution\
{%- if contributor.pr_number %} in [#{{ contributor.pr_number }}]({{ self::remote_url() }}/pull/{{ contributor.pr_number }}){% endif %}
{% endfor %}
{% endif -%}

{% if version -%}
**Full Changelog**: [`{{ previous.version }}...{{ version }}`]({{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }})
{% endif %}{% endraw %}
"""
footer = """
---

<sub>Generated with [git-cliff](https://git-cliff.org)</sub>
"""
trim = true

[git]
conventional_commits = true
filter_unconventional = true
split_commits = false
commit_preprocessors = [
    { pattern = '\((\w+)\s?\#([0-9]+)\)', replace = "([#${2}](https://github.com/{{gh_username}}/{{project-name}}/issues/${2}))" },
]
commit_parsers = [
    { message = "^feat", group = "Features" },
    { message = "^fix", group = "Bug Fixes" },
    { message = "^doc", group = "Documentation" },
    { message = "^perf", group = "Performance" },
    { message = "^refactor", group = "Refactor" },
    { message = "^style", group = "Styling" },
    { message = "^test", group = "Testing" },
    { message = "^chore\\(release\\)", skip = true },
    { message = "^chore\\(deps\\)", skip = true },
    { message = "^chore\\(pr\\)", skip = true },
    { message = "^chore\\(pull\\)", skip = true },
    { message = "^chore: update CHANGELOG", skip = true },
    { message = "^chore|^ci", group = "Miscellaneous" },
    { body = ".*security", group = "Security" },
    { message = "^revert", group = "Reverted" },
]
protect_breaking_commits = false
filter_commits = false
topo_order = false
sort_commits = "newest"

[remote.github]
owner = "{{gh_username}}"
repo = "{{project-name}}"