rustible/cliff.toml at main · kernelfirma/rustible · 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 for changelog generation
# https://git-cliff.org/docs/configuration

[changelog]
# Template for the changelog header
header = """
# Changelog

All notable changes to Rustible 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).

"""
# Template for the changelog body
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 }}\
{% if commit.breaking %} **BREAKING**{% endif %}\
{% if commit.github.pr_number %} ([#{{ commit.github.pr_number }}](https://github.com/rustible/rustible/pull/{{ commit.github.pr_number }})){% endif %}\
{% if commit.github.username %} by @{{ commit.github.username }}{% endif %}
{%- endfor %}
{% endfor %}

"""
# Template for the changelog footer
footer = """
---
"""
# Remove leading and trailing whitespace
trim = true
# Postprocessors for changelog content
postprocessors = []

[git]
# Parse conventional commits
conventional_commits = true
# Filter out commits not following conventional commit spec
filter_unconventional = true
# Process each line of commit message separately
split_commits = false
# Regex for preprocessing commit messages
commit_preprocessors = [
  # Remove issue numbers from commit messages
  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "" },
  # Replace multiple spaces with single space
  { pattern = "  +", replace = " " },
]
# Regex for parsing and grouping commits
commit_parsers = [
  { message = "^feat", group = "Features" },
  { message = "^fix", group = "Bug Fixes" },
  { message = "^doc", group = "Documentation" },
  { message = "^perf", group = "Performance" },
  { message = "^refactor", group = "Refactoring" },
  { message = "^style", group = "Styling" },
  { message = "^test", group = "Testing" },
  { message = "^chore\\(release\\)", skip = true },
  { message = "^chore\\(deps\\)", group = "Dependencies" },
  { message = "^chore\\(pr\\)", skip = true },
  { message = "^chore\\(pull\\)", skip = true },
  { message = "^chore\\(ci\\)", group = "CI/CD" },
  { message = "^chore", group = "Miscellaneous" },
  { message = "^build", group = "Build System" },
  { message = "^ci", group = "CI/CD" },
  { message = "^revert", group = "Reverts" },
  { message = "^security", group = "Security" },
  # Catch-all for non-conventional commits
  { body = ".*security", group = "Security" },
  { body = "BREAKING CHANGE", group = "Breaking Changes" },
]
# Protect breaking changes from being skipped
protect_breaking_commits = true
# Filter commits by patterns
filter_commits = false
# Glob patterns for tags
tag_pattern = "v[0-9].*"
# Regex for skipping tags
skip_tags = ""
# Ignore tags by regex
ignore_tags = ""
# Sort commits chronologically
topo_order = false
# Sort order
sort_commits = "oldest"
# Limit the number of commits per release
# limit_commits = 42

[remote.github]
owner = "rustible"
repo = "rustible"