tern/cliff.toml at trunk · wack/tern · 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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# git-cliff configuration for changelog generation
# https://git-cliff.org/docs/configuration

# These are the rules we use to determine what the next version should be, adhering to SemVer.
[bump]
features_always_bump_minor = true
breaking_always_bump_major = true
initial_tag = "0.1.0"

[changelog]
# changelog header
header = """
# Changelog

All notable changes to this project will be documented in this file.

"""
# template for the changelog body
# https://keats.github.io/tera/docs/
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 %}\
            {% if commit.breaking %}[**BREAKING**] {% endif %}\
            {{ commit.message | upper_first }}\
    {% endfor %}
{% endfor %}\n
"""
# template for the changelog footer
footer = ""
# remove the leading and trailing whitespace from the templates
trim = true
# postprocessors
postprocessors = []

[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = true
# filter out the commits that are not conventional
filter_unconventional = true
# process each line of a commit as an individual commit
split_commits = true
# regex for preprocessing the commit messages
commit_preprocessors = [
  # Strip leading/trailing whitespace
  { pattern = '^\s+|\s+$', replace = "" },
]
# regex for parsing and grouping commits
# Note: Patterns use (^|\\n) to match at start of any line because with split_commits=true,
# the commit_parsers are matched against the full commit message BEFORE splitting into lines.
commit_parsers = [
  # Breaking changes - highest priority
  { message = "(^|\\n)(?i)BREAKING[:\\s]", group = "Breaking Changes" },
  { message = "(?i)\\[BREAKING\\]", group = "Breaking Changes" },
  { body = "(?i)BREAKING CHANGE", group = "Breaking Changes" },

  # Security fixes
  { message = "(^|\\n)(?i)SECURITY[:\\s]", group = "Security" },
  { message = "(?i)\\[SECURITY\\]", group = "Security" },

  # Bug fixes
  { message = "(^|\\n)(?i)BUG[:\\s]", group = "Bug Fixes" },
  { message = "(?i)\\[BUG\\]", group = "Bug Fixes" },

  # Features
  { message = "(^|\\n)(?i)FEAT[:\\s]", group = "Features" },
  { message = "(^|\\n)(?i)FEATURE[:\\s]", group = "Features" },
  { message = "(?i)\\[FEAT\\]", group = "Features" },

  # Documentation
  { message = "(^|\\n)(?i)DOCS[:\\s]", group = "Documentation" },
  { message = "(^|\\n)(?i)DOC[:\\s]", group = "Documentation" },
  { message = "(?i)\\[DOCS\\]", group = "Documentation" },

  # Refactoring
  { message = "(^|\\n)(?i)REFACTOR[:\\s]", group = "Refactoring" },
  { message = "(?i)\\[REFACTOR\\]", group = "Refactoring" },

  # Performance
  { message = "(^|\\n)(?i)PERF[:\\s]", group = "Performance" },
  { message = "(?i)\\[PERF\\]", group = "Performance" },

  # Testing
  { message = "(^|\\n)(?i)TEST[:\\s]", group = "Testing" },
  { message = "(?i)\\[TEST\\]", group = "Testing" },

  # Build/CI
  { message = "(^|\\n)(?i)CI[:\\s]", group = "Build" },
  { message = "(?i)\\[CI\\]", group = "Build" },

  # Chores
  { message = "(^|\\n)(?i)CHORE[:\\s]", group = "Miscellaneous" },
  { message = "(?i)\\[CHORE\\]", group = "Miscellaneous" },
]
# protect breaking changes from being skipped due to matching a skipping commit_parser
protect_breaking_commits = false
# filter out the commits that are not matched by commit parsers
filter_commits = true
# regex for matching git tags
tag_pattern = "v[0-9].*"
# regex for skipping tags
skip_tags = ""
# regex for ignoring tags
ignore_tags = ""
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "oldest"
# limit the number of commits included in the changelog
# limit_commits = 42