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
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration
[]
# A Tera template to be rendered as the changelog's footer.
# See https://keats.github.io/tera/docs/#introduction
= """
# Changelog\n
All notable changes to unsynn will be documented in this file.\n
"""
# A Tera template to be rendered for each release in the changelog.
# See https://keats.github.io/tera/docs/#introduction
= """
{% 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 | unique(attribute="message") %}
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
{% if commit.breaking %}[**breaking**] {% endif %}\
{{ commit.message | upper_first | escape_xml }} \
[[commit](<REPO>/commits/{{ commit.id }})]
{% endfor %}
{% endfor %}\n
"""
# A Tera template to be rendered as the changelog's footer.
# See https://keats.github.io/tera/docs/#introduction
= """
<!-- generated by git-cliff -->
"""
# Remove leading and trailing whitespaces from the changelog's body.
= true
# Render body even when there are no releases to process.
= true
# An array of regex based postprocessors to modify the changelog.
= [
# Replace the placeholder <REPO> with a URL.
{ = '<REPO>', = "https://seed.pipapo.org/nodes/seed.pipapo.org/rad:z39WbeupErKS8TwbDS5yU8eZSa3C" },
]
# render body even when there are no releases to process
# render_always = true
# output file path
= "CHANGELOG.md"
[]
# Parse commits according to the conventional commits specification.
# See https://www.conventionalcommits.org
= true
# Exclude commits that do not match the conventional commits specification.
= true
# Require all commits to be conventional.
# Takes precedence over filter_unconventional.
= false
# Split commits on newlines, treating each line as an individual commit.
= false
# An array of regex based parsers to modify commit messages prior to further processing.
= [
# Replace issue numbers with link templates to be updated in `changelog.postprocessors`.
#{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
# Check spelling of the commit message using https://github.com/crate-ci/typos.
# If the spelling is incorrect, it will be fixed automatically.
#{ pattern = '.*', replace_command = 'typos --write-changes -' },
]
# Prevent commits that are breaking from being excluded by commit parsers.
= false
# An array of regex based parsers for extracting data from the commit message.
# Assigns commits to groups.
# Optionally sets the commit's scope and can decide to exclude commits from further processing.
= [
{ = "^NEW:", = "<!-- 000 -->โจ New Features" },
{ = "^ADD:", = "<!-- 010 -->โจ Extended Features" },
{ = "^FIX:", = "<!-- 020 -->๐ชณ Bug Fixes" },
{ = "^CHANGE:", = "<!-- 030 -->๐ฅ Breaking Changes" },
{ = "^BREAK:", = "<!-- 030 -->๐ฅ Breaking Changes" },
{ = "^DEPRECATE", = "<!-- 040 -->๐ชฆ Deprecated Features" },
{ = "^REMOVE:", = "<!-- 050 -->๐ชฆ Removed Feature" },
{ = "^REFACTOR", = "<!-- 060 -->โ๏ธ Refactor" },
{ = "^PERF:", = "<!-- 070 -->โก Performance improvement" },
{ = "^DOC:", = "<!-- 080 -->๐ Documentation" },
{ = "^DOCFIX:", = "<!-- 080 -->๐ Documentation fixed" },
{ = "^CHORE:", = "<!-- 090 -->๐งน Maintenance" },
#{ message = "^BUG:", group = "<!-- 090 -->๐ชณ Known Bug" },
#{ message = "^WIP:", group = "<!-- 090 -->๐ง Work in Progress" },
#{ message = "^PLANNED:", group = "<!-- 090 -->๐ญ Planned/Ideas" },
#{ message = "^IDEA:", group = "<!-- 090 -->๐ญ Planned/Ideas" },
{ = "^REVERT:", = true },
{ = "^TEST:", = true },
{ = "^RENAME:", = true },
{ = "^LINT:", = true },
{ = "^STYLE:", = true },
{ = ".*", = true },
]
# Exclude commits that are not matched by any commit parser.
= false
# An array of link parsers for extracting external references, and turning them into URLs, using regex.
= []
# Include only the tags that belong to the current branch.
= false
# Order releases topologically instead of chronologically.
= false
# Order releases topologically instead of chronologically.
= true
# Order of commits in each group/release within the changelog.
# Allowed values: newest, oldest
= "oldest"
# Process submodules commits
= false