mitto/cliff.toml at main · inercia/mitto · 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
101
102
# git-cliff configuration for generating release notes
# https://git-cliff.org/docs/configuration

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

# Template for the changelog body
# Note: GitHub metadata (username, PR) is only available when GITHUB_TOKEN is set
body = """
{% if version %}\
    ## {{ version | trim_start_matches(pat="v") }}
{% 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 }} ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/inercia/mitto/commit/{{ commit.id }}))\
    {% endfor %}
{% endfor %}
"""

# Template for the changelog footer
footer = """
{% for release in releases -%}
    {% if release.version -%}
        {% if release.previous.version -%}
**Full Changelog**: [{{ release.previous.version }}...{{ release.version }}](https://github.com/inercia/mitto/compare/{{ release.previous.version }}...{{ release.version }})
        {% endif -%}
    {% endif -%}
{% endfor %}
"""

# Remove leading and trailing whitespace from templates
trim = true

# Postprocessors for the changelog
postprocessors = [
    { pattern = '<REPO>', replace = "https://github.com/inercia/mitto" },
]

[git]
# Parse conventional commits
conventional_commits = true

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

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

# Regex for preprocessing commit messages
commit_preprocessors = [
    # Remove issue numbers from commit messages
    { pattern = '\((\w+\s)?#([0-9]+)\)', 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.*\\)", skip = true },
    { message = "^chore\\(pr\\)", skip = true },
    { message = "^chore\\(pull\\)", skip = true },
    { message = "^chore|^ci", group = "⚙️ Miscellaneous" },
    { body = ".*security", group = "🔒 Security" },
    { message = "^revert", group = "◀️ Reverts" },
]

# Protect breaking changes from being skipped
protect_breaking_commits = true

# Filter out commits by patterns
filter_commits = false

# Tag pattern for releases
tag_pattern = "v[0-9].*"

# Regex for skipping tags
skip_tags = ""

# Regex for ignoring tags
ignore_tags = ""

# Sort commits by date
topo_order = false

# Sort order for commits (oldest or newest first)
sort_commits = "oldest"

# Limit the number of commits included in the changelog
# limit_commits = 42