jcg.re
this repo has no description
1# configuration file for git-cliff (0.1.0)
2
3[changelog]
4# changelog header
5header = """
6# Changelog\n
7All notable changes to this project will be documented in this file.\n
8"""
9# template for the changelog body
10# https://tera.netlify.app/docs/#introduction
11body = """
12{% if version %}\
13 ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
14{% else %}\
15 ## [unreleased]
16{% endif %}\
17{% for group, commits in commits | group_by(attribute="group") %}
18 ### {{ group | upper_first }}
19 {% for commit in commits %}
20 - {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\
21 {% endfor %}
22{% endfor %}\n
23"""
24# remove the leading and trailing whitespace from the template
25trim = true
26# changelog footer
27footer = """
28<!-- generated by git-cliff -->
29<!-- update with `git cliff --tag <new version> 7cf8502fb9d0c04bab48a2d7d7e819c98f9aed6e.. > CHANGELOG.md` -->
30"""
31
32[git]
33# parse the commits based on https://www.conventionalcommits.org
34conventional_commits = true
35# filter out the commits that are not conventional
36filter_unconventional = true
37# process each line of a commit as an individual commit
38split_commits = false
39# regex for preprocessing the commit messages
40commit_preprocessors = [
41 # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, # replace issue numbers
42]
43# regex for parsing and grouping commits
44commit_parsers = [
45 { message = "^feat", group = "Features"},
46 { message = "^fix", group = "Bug Fixes"},
47 { message = "^doc", group = "Documentation"},
48 { message = "^perf", group = "Performance"},
49 { message = "^refactor", group = "Refactor"},
50 { message = "^style", group = "Styling"},
51 { message = "^test", group = "Testing"},
52 { message = "^chore\\(release\\): prepare for", skip = true},
53 { message = "^chore", group = "Miscellaneous Tasks"},
54 { body = ".*security", group = "Security"},
55]
56# protect breaking changes from being skipped due to matching a skipping commit_parser
57protect_breaking_commits = false
58# filter out the commits that are not matched by commit parsers
59filter_commits = false
60# glob pattern for matching git tags
61tag_pattern = "v[0-9]*"
62# regex for skipping tags
63skip_tags = "v0.1.0-beta.1"
64# regex for ignoring tags
65ignore_tags = ""
66# sort the tags topologically
67topo_order = false
68# sort the commits inside sections by oldest/newest order
69sort_commits = "oldest"
70# limit the number of commits included in the changelog.
71# limit_commits = 42
72
73[bump]
74breaking_always_bump_major = false