fork/eza

git clone https://git.julia.blue/fork/eza

Christina SørensenMerge pull request #482 from eza-community/cafk-better-release143a7392

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