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
[]
# changelog header
= """
# Changelog\n
All notable changes to this project will be documented in this file.\n
"""
# template for the changelog body
# 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 %}
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
{% if commit.breaking %}[**breaking**] {% endif %}\
{{ commit.message | upper_first }}\
{% endfor %}
{% endfor %}\n
"""
# remove the leading and trailing s
= true
# postprocessors
= [
# { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
]
[]
# parse the commits based on https://www.conventionalcommits.org
= true
# filter out the commits that are not conventional
= true
# process each line of a commit as an individual commit
= false
# regex for preprocessing the commit messages
= [
# Replace issue numbers
#{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
# Check spelling of the commit with https://github.com/crate-ci/typos
# If the spelling is incorrect, it will be automatically fixed.
#{ pattern = '.*', replace_command = 'typos --write-changes -' },
]
# regex for parsing and grouping commits
= [
{ = "^feat", = "<!-- 0 -->🚀 Features" },
{ = "^fix", = "<!-- 1 -->🐛 Bug Fixes" },
{ = "^config", = "<!-- 3 -->🔧 Configuration" },
{ = "^perf", = "<!-- 4 -->⚡ Performance" },
{ = "^style", = "<!-- 5 -->🎨 Styling" },
]
# protect breaking changes from being skipped due to matching a skipping commit_parser
= false
# filter out the commits that are not matched by commit parsers
= 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
= false
# sort the commits inside sections by oldest/newest order
= "newest"
# limit the number of commits included in the changelog.
# limit_commits = 42