Ceres/cliff.toml at master · AndreaBozzo/Ceres · 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
# git-cliff configuration for Ceres
# https://git-cliff.org

[changelog]
# Changelog header
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).

"""

# Template for the changelog body
# Uses Tera templating: https://keats.github.io/tera/
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 }}
{% for commit in commits %}
- {% if commit.scope %}**{{ commit.scope }}**: {% endif %}\
{{ commit.message | upper_first }}\
{% endfor %}
{% endfor %}
"""

# Template for the changelog footer
footer = ""

# Remove leading and trailing whitespace from templates
trim = true

# Postprocessors for commit messages
postprocessors = [
    # Remove PR numbers from the end of commit messages for cleaner display
    { pattern = '\s*\(#\d+\)', replace = "" },
]

[git]
# Parse conventional commits
conventional_commits = true

# Filter out commits that don't follow conventional commits
filter_unconventional = true

# Process each line of a commit as an individual commit
split_commits = false

# Regex for parsing commit messages
commit_parsers = [
    { message = "^feat", group = "Added" },
    { message = "^fix", group = "Fixed" },
    { message = "^doc", group = "Documentation" },
    { message = "^docs", group = "Documentation" },
    { message = "^perf", group = "Performance" },
    { message = "^refactor", group = "Changed" },
    { message = "^enhance", group = "Changed" },
    { message = "^style", group = "Changed" },
    { message = "^test", group = "Testing" },
    { message = "^chore\\(release\\)", skip = true },
    { message = "^chore\\(deps\\)", group = "Dependencies" },
    { message = "^chore\\(ci\\)", group = "CI/CD" },
    { message = "^ci", group = "CI/CD" },
    { message = "^chore", group = "Miscellaneous" },
    { message = "^revert", group = "Reverted" },
    # Skip merge commits
    { message = "^Merge", skip = true },
]

# Protect breaking changes from being skipped
protect_breaking_commits = true

# Filter commits by their group
filter_commits = false

# Glob pattern for matching git tags
tag_pattern = "v[0-9].*"

# Sort commits oldest to newest within each section
sort_commits = "oldest"