-
Notifications
You must be signed in to change notification settings - Fork 0
/
cliff.toml
136 lines (114 loc) · 5.25 KB
/
cliff.toml
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# git-cliff ~ default configuration file
# https://git-cliff.org/docs/configuration
#
# Lines starting with "#" are comments.
# Configuration options are organized into tables and keys.
# See documentation for more information on available options.
[remote.github]
owner = "northwood-labs"
repo = "csp-parser"
# token = "" # Use GITHUB_TOKEN environment variable instead.
# goplicate-start:changelog
[changelog]
header = """
# CHANGELOG
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com), adheres to [Semantic Versioning](https://semver.org), and uses [Conventional Commit](https://www.conventionalcommits.org) syntax.
"""
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
body = """
{% if version %}
## {{ version | trim_start_matches(pat="v") }} — {{ timestamp | date(format="%Y-%m-%d") }}
{% if previous.version %}
[Compare: {{ previous.version }} → {{ version }}]({{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }})
{% endif %}\
{% else %}
## Unreleased
{% if previous.version %}
[Compare: {{ previous.version }} → `HEAD`]({{ self::remote_url() }}/compare/{{ previous.version }}..HEAD)
{% endif %}\
{% endif %}\
{% for group, commits in commits | filter(attribute="merge_commit", value=false) | group_by(attribute="group") %}
### {{ group | upper_first }}
{% for commit in commits %}
{% set commit_message = commit.message -%}
* {% if commit.breaking %}**[BC BREAK]** {% endif %}\
[`{{ commit.id | truncate(length=7, end="") }}`]({{ self::remote_url() }}/commit/{{ commit.id }}): {% if commit.scope %}\
**{{ commit.scope }}**: {% endif %}{{ commit_message | split(pat="\n") | first | upper_first | trim_end }} \
({% if commit.github.username %}[@{{ commit.github.username | replace(from="[bot]", to="") }}](https://github.com/{{ commit.github.username | replace(from="[bot]", to="") }}){%- endif -%})\
{%- endfor %}
{% endfor %}
{%- macro remote_url() -%}
https://github.com/northwood-labs/terraform-provider-corefunc
{%- endmacro -%}
"""
# remove the leading and trailing whitespace from the template
trim = true
# changelog footer
footer = """
<p>Generated on {{ now() | date(format="%Y-%m-%d") }}.</p>
"""
# goplicate-end:changelog
postprocessors = [
{ pattern = "([^ ]+)\\(\\)", replace = "`$0`" },
{ pattern = "AUTHORS|CONTRIBUTORS|CONTRIBUTING|README", replace = "$0.md" },
{ pattern = "([^ ]+)\\.md", replace = "`$0`" },
{ pattern = "([^ ]+)\\.ya?ml", replace = "`$0`" },
{ pattern = "\\.md\\.md", replace = ".md" },
{ pattern = "go\\.(mod|sum)", replace = "`$0`" },
{ pattern = "(?i)pkg\\.go\\.dev", replace = "`$0`" },
{ pattern = "Bump ([^ ]+)", replace = "Bump `$1`" },
{ pattern = "\\(#([0-9]+)\\)", replace = "([#${1}](@REPO/issues/${1}))" },
{ pattern = '@REPO', replace = "https://github.com/northwood-labs/csp-parser" },
]
# goplicate-start:git
[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = true
# filter out the commits that are not conventional
filter_unconventional = true
# process each line of a commit as an individual commit
split_commits = false
# regex for preprocessing the commit messages
commit_preprocessors = [
# { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"}, # replace issue numbers
]
# regex for parsing and grouping commits
commit_parsers = [
{ message = "^feat", group = "<!-- 0 -->:rocket: Features" },
{ message = "^fix", group = "<!-- 1 -->:bug: Bug Fixes" },
{ message = "^perf", group = "<!-- 2 -->:racecar: Performance" },
{ message = "^docs", group = ":books: Documentation" },
{ message = "^refactor", group = ":tractor: Refactor" },
{ message = "^style", group = ":art: Styling" },
{ message = "^sync", group = "<!-- ZXX -->:arrows_counterclockwise: Configuration Syncing" },
{ message = "^build|deps", group = ":dependabot: Building and Dependencies" },
{ message = "^test", group = ":test_tube: Testing" },
{ message = "^lint", group = ":soap: Linting" },
{ message = "^chore\\(release\\): prepare for", skip = true },
{ message = "^chore\\(deps\\)", skip = true },
{ message = "^chore\\(pr\\)", skip = true },
{ message = "^chore\\(pull\\)", skip = true },
{ message = "^relprep", skip = true },
{ message = "^chore|ci", group = "<!-- ZZZ -->:gear: Miscellaneous Tasks" },
{ message = "^security", group = ":closed_lock_with_key: Security" },
{ body = ".*security", group = ":closed_lock_with_key: Security" },
{ message = "^revert", group = "<!-- ZYY -->:x: Revert" },
{ message = "^automation", skip = true },
]
# protect breaking changes from being skipped due to matching a skipping commit_parser
protect_breaking_commits = false
# filter out the commits that are not matched by commit parsers
filter_commits = false
# regex for matching git tags
tag_pattern = "v[0-9].*"
# regex for skipping tags
skip_tags = "beta|alpha"
# regex for ignoring tags
ignore_tags = "rc"
# sort the tags topologically
topo_order = true
# sort the commits inside sections by oldest/newest order
sort_commits = "oldest"
# goplicate-end:git