1- # configuration file for git-cliff (0.1.0)
2-
31[changelog ]
42# changelog header
53header = """
64# Changelog\n
75All notable changes to this project will be documented in this file.\n
86"""
97# template for the changelog body
10- # https://tera.netlify.app/docs/#introduction
118body = """
129{% if version %}\
13- ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
10+ ## [{{ version }}] - {{ timestamp | date(format="%Y-%m-%d") }}
1411{% else %}\
1512 ## [unreleased]
1613{% endif %}\
1714{% 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 %}
2215 ### {{ group | upper_first }}
23- {% endif %}
2416 {% for commit in commits %}
25- - {% if commit.breaking %}[**breaking**] {% endif %}{ { commit.message | upper_first }}\
17+ - {{ commit.message | upper_first }}\
2618 {% endfor %}
2719{% endfor %}\n
2820"""
@@ -40,23 +32,23 @@ filter_unconventional = false
4032split_commits = false
4133# regex for preprocessing the commit messages
4234commit_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
4636]
4737# regex for parsing and grouping commits
4838commit_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" },
5949]
50+ # protect breaking changes from being skipped due to matching a skipping commit_parser
51+ protect_breaking_commits = false
6052# filter out the commits that are not matched by commit parsers
6153filter_commits = false
6254# glob pattern for matching git tags
@@ -65,7 +57,9 @@ tag_pattern = "[0-9]*"
6557skip_tags = " v0.1.0-beta.1"
6658# regex for ignoring tags
6759ignore_tags = " "
68- # sort the tags chronologically
69- date_order = false
60+ # sort the tags topologically
61+ topo_order = false
7062# sort the commits inside sections by oldest/newest order
7163sort_commits = " oldest"
64+ # limit the number of commits included in the changelog.
65+ # limit_commits = 42
0 commit comments