lambda-powertools-reference/cliff.toml at main · timpugh/lambda-powertools-reference · 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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration
#
# Regenerate CHANGELOG.md from current git history with:
#   git cliff --tag v$(yq '.project.version' pyproject.toml) -o CHANGELOG.md
# Or for an unreleased section against HEAD:
#   git cliff --unreleased --prepend CHANGELOG.md

[remote.github]
owner = "timpugh"
repo = "lambda-powertools-reference"

[changelog]
# A Tera template to be rendered as the changelog's header.
# See https://keats.github.io/tera/docs/#introduction
header = """
# Changelog\n
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n
"""
# A Tera template to be rendered for each release in the changelog.
# See https://keats.github.io/tera/docs/#introduction
body = """
{% if version -%}
    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else -%}
    ## [Unreleased]
{% endif -%}
{% for group, commits in commits | group_by(attribute="group") %}
    ### {{ group | upper_first }}
    {% for commit in commits %}
        - {{ commit.message | split(pat="\n") | first | upper_first | trim }}\
    {% endfor %}
{% endfor %}\n
"""
# A Tera template to be rendered as the changelog's footer.
# See https://keats.github.io/tera/docs/#introduction
footer = """
{% for release in releases -%}
    {% if release.version -%}
        {% if release.previous.version -%}
            [{{ release.version | trim_start_matches(pat="v") }}]: \
                https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
                    /compare/{{ release.previous.version }}..{{ release.version }}
        {% else -%}
            [{{ release.version | trim_start_matches(pat="v") }}]: \
                https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
                    /tree/{{ release.version }}
        {% endif -%}
    {% else -%}
        [unreleased]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}\
            /compare/{{ release.previous.version }}..HEAD
    {% endif -%}
{% endfor %}
<!-- generated by git-cliff -->
"""
# Remove leading and trailing whitespaces from the changelog's body.
trim = true

[git]
# Parse commits according to the conventional commits specification.
# See https://www.conventionalcommits.org
conventional_commits = true
# Exclude commits that do not match the conventional commits specification.
filter_unconventional = false
# Maps conventional-commit types onto Keep-a-Changelog groups. Order matters
# — first match wins. Anything that doesn't match falls into "Changed".
#
# Dependabot commits (build(deps), chore(deps), and the rendered "Bump X from
# Y to Z" form after the conventional prefix is stripped) are skipped: their
# history is in git log + the dependency lockfiles, and including 50+ version
# bumps in a public-facing changelog drowns the actual feature/fix story.
commit_parsers = [
    { message = "^build\\(deps\\)", skip = true },
    { message = "^chore\\(deps\\)", skip = true },
    { message = "^[Bb]ump ",         skip = true },
    { message = "^Merge pull request", skip = true },
    { message = "^feat",      group = "Added" },
    { message = "^fix",       group = "Fixed" },
    { message = "^revert",    group = "Removed" },
    { message = "^perf",      group = "Performance" },
    { message = "^security",  group = "Security" },
    { message = "^docs",      group = "Documentation" },
    { message = "^test",      group = "Tests" },
    { message = "^refactor",  group = "Refactored" },
    { message = "^build",     group = "Build" },
    { message = "^ci",        group = "CI/CD" },
    { message = "^chore",     group = "Maintenance" },
    { message = "^.*",        group = "Changed" },
]
# Prevent commits that are breaking from being excluded by commit parsers.
filter_commits = false
# Order releases topologically instead of chronologically.
topo_order = false
# Order of commits in each group/release within the changelog.
# Allowed values: newest, oldest
sort_commits = "oldest"