python-template/cliff.toml at main · veralvx/python-template · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# git-cliff (a generated project pins 2.13.1): the changelog (`just changelog`, written by
# `just release`), from the commits -- in a workspace, a package's: those touching its folder.
# The recipes pass what is project-specific: the repository and, in a generated project, the tags
# (`v1.2.3`, a workspace's `name-v1.2.3`) and a member's folder. Grouped by commit type; a
# commit's subject is its entry, written for its users.

[changelog]
header = """
# Changelog

Generated by [git-cliff](https://git-cliff.org) from the conventional commits; versions follow
[Semantic Versioning](https://semver.org).\n
"""
body = """
{% set url = "https://github.com/" ~ remote.github.owner ~ "/" ~ remote.github.repo -%}
{% if version -%}
    ## [{{ version | split(pat="-v") | last | trim_start_matches(pat="v") }}]({{ url }}/\
    {%- if previous.version %}compare/{{ previous.version }}..{{ version }}\
    {%- else %}tree/{{ version }}{% endif %}) - {{ timestamp | date(format="%Y-%m-%d") }}
{% elif previous.version -%}
    ## [Unreleased]({{ url }}/compare/{{ previous.version }}..HEAD)
{% else -%}
    ## Unreleased
{% endif -%}
{% for group, commits in commits | group_by(attribute="group") %}
    ### {{ group | striptags | trim }}
    {% for commit in commits %}
        - {% if commit.scope %}{{ commit.scope }}: {% endif %}\
          {{ commit.message | split(pat="\n") | first | trim }}\
    {% endfor %}
{% endfor %}\n
"""
trim = true

[git]
conventional_commits = true
# what cog lets through unconventional -- merges, fixups (cog.toml) -- skipped below, unwarned
filter_unconventional = false
protect_breaking_commits = true # a breaking change is listed whatever its type, first
# by type, the HTML comments ordering the groups. Skipped: what changes nothing a user meets --
# the release's own commit (`chore(release)`), chores, CI, formatting -- and cog's ignored ones
commit_parsers = [
    { message = "^(Merge |fixup! |squash! |amend! )", skip = true },
    { message = "^[a-z]+(\\([^)]*\\))?!:", group = "<!-- 0 -->Breaking changes" },
    { footer = "^BREAKING[ -]CHANGE", group = "<!-- 0 -->Breaking changes" },
    { message = "^(chore|ci|style)", skip = true },
    { message = "^feat", group = "<!-- 1 -->Features" },
    { message = "^fix", group = "<!-- 2 -->Fixes" },
    { message = "^perf", group = "<!-- 3 -->Performance" },
    { message = "^refactor", group = "<!-- 4 -->Refactoring" },
    { message = "^build", group = "<!-- 5 -->Build" },
    { message = "^doc", group = "<!-- 6 -->Documentation" },
    { message = "^test", group = "<!-- 7 -->Tests" },
    { message = "^revert", group = "<!-- 8 -->Reverts" },
    { message = ".*", group = "<!-- 9 -->Other" },
]
sort_commits = "oldest"