fork/eza

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

Christina Sørensenfix: git cliff docs issuef9f82eef

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