1
- # configuration file for git-cliff (0.1.0)
2
-
3
1
[changelog ]
4
2
# changelog header
5
3
header = """
6
4
# Changelog\n
7
5
All notable changes to this project will be documented in this file.\n
8
6
"""
9
7
# template for the changelog body
10
- # https://tera.netlify.app/docs/#introduction
11
8
body = """
12
9
{% if version %}\
13
- ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
10
+ ## [{{ version }}] - {{ timestamp | date(format="%Y-%m-%d") }}
14
11
{% else %}\
15
12
## [unreleased]
16
13
{% endif %}\
17
14
{% for group, commits in commits | group_by(attribute="group") %}
18
- {% if group is starting_with("FAI-") %}
19
- {% set issue_id = group | trim_start_matches(pat="FAI-") -%}
20
- ### [FAI-{{ issue_id }}](https://issues.redhat.com/browse/FAI-{{ issue_id }})
21
- {% else %}
22
15
### {{ group | upper_first }}
23
- {% endif %}
24
16
{% for commit in commits %}
25
- - {% if commit.breaking %}[**breaking**] {% endif %}{ { commit.message | upper_first }}\
17
+ - {{ commit.message | upper_first }}\
26
18
{% endfor %}
27
19
{% endfor %}\n
28
20
"""
@@ -40,23 +32,23 @@ filter_unconventional = false
40
32
split_commits = false
41
33
# regex for preprocessing the commit messages
42
34
commit_preprocessors = [
43
- { pattern = ' \((\w+\s)?#([0-9]+)\)' , replace = " ([#${2}](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/${2}))" },
44
- { pattern = ' FAI-([0-9]+)\s' , replace = " [FAI-${1}](https://issues.redhat.com/browse/FAI-${1})" },
45
- # { pattern = 'FAI-([0-9]+)\s', replace = "[FAI-${1}](https://issues.redhat.com/browse/FAI-${1})"},
35
+ # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, # replace issue numbers
46
36
]
47
37
# regex for parsing and grouping commits
48
38
commit_parsers = [
49
- { message = " ^feat" , group = " Features" },
50
- { message = " ^fix" , group = " Bug Fixes" },
51
- { message = " ^doc" , group = " Documentation" },
52
- { message = " ^perf" , group = " Performance" },
53
- { message = " ^refactor" , group = " Refactor" },
54
- { message = " ^style" , group = " Styling" },
55
- { message = " ^test" , group = " Testing" },
56
- { message = " ^chore\\ (release\\ ): prepare for" , skip = true },
57
- { message = " ^chore" , group = " Miscellaneous Tasks" },
58
- { body = " .*security" , group = " Security" },
39
+ { message = " ^feat" , group = " Features" },
40
+ { message = " ^fix" , group = " Bug Fixes" },
41
+ { message = " ^doc" , group = " Documentation" },
42
+ { message = " ^perf" , group = " Performance" },
43
+ { message = " ^refactor" , group = " Refactor" },
44
+ { message = " ^style" , group = " Styling" },
45
+ { message = " ^test" , group = " Testing" },
46
+ { message = " ^chore\\ (release\\ ): prepare for" , skip = true },
47
+ { message = " ^chore" , group = " Miscellaneous Tasks" },
48
+ { body = " .*security" , group = " Security" },
59
49
]
50
+ # protect breaking changes from being skipped due to matching a skipping commit_parser
51
+ protect_breaking_commits = false
60
52
# filter out the commits that are not matched by commit parsers
61
53
filter_commits = false
62
54
# glob pattern for matching git tags
@@ -65,7 +57,9 @@ tag_pattern = "[0-9]*"
65
57
skip_tags = " v0.1.0-beta.1"
66
58
# regex for ignoring tags
67
59
ignore_tags = " "
68
- # sort the tags chronologically
69
- date_order = false
60
+ # sort the tags topologically
61
+ topo_order = false
70
62
# sort the commits inside sections by oldest/newest order
71
63
sort_commits = " oldest"
64
+ # limit the number of commits included in the changelog.
65
+ # limit_commits = 42
0 commit comments