gatekeeper/cliff.toml at master · IndulekhaPrathapan/gatekeeper · 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
# git-cliff configuration for Gatekeeper release notes.
# Generates categorized release notes from conventional commits.

[remote.github]
owner = "open-policy-agent"
repo = "gatekeeper"
# token via GITHUB_TOKEN env var in CI

[changelog]
header = ""
body = """
{%- macro remote_url() -%}
  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
{%- endmacro -%}

{% for group, commits in commits | filter(attribute="merge_commit", value=false) | group_by(attribute="group") %}
## {{ group | striptags | trim | upper_first }}

{% for commit in commits -%}
- {% if commit.scope %}**{{ commit.scope }}**: {% endif %}{{ commit.message | upper_first | trim }}\
{% if commit.remote.pr_number %} [#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }})\
{% endif %} ([{{ commit.author.name }}]({{ self::remote_url() }}/commit/{{ commit.id }}))
{% endfor %}
{% endfor %}
"""
trim = true
footer = ""

[git]
conventional_commits = true
filter_unconventional = false
split_commits = false
# Ensure breaking-change commits are never silently skipped by a commit_parser.
protect_breaking_commits = true
filter_commits = false
tag_pattern = "v[0-9].*"
topo_order = false
sort_commits = "oldest"

# strip multiple lines
commit_preprocessors = [
  { pattern = '\n[\s\S]*', replace = "" },
]

# mirrors the list in .github/semantic.yml.
# HTML comment prefixes (<!-- N -->) control group display order.
# any commit not matching a rule will be under "Other Changes".
commit_parsers = [
  { message = "^feat", group = "<!-- 00 -->Features" },
  { message = "^fix", group = "<!-- 01 -->Bug Fixes" },
  { message = "^perf", group = "<!-- 02 -->Performance" },
  { message = "^refactor", group = "<!-- 03 -->Refactors" },
  { message = "^revert", group = "<!-- 04 -->Reverts" },
  { message = "^docs", group = "<!-- 05 -->Documentation" },
  { message = "^test", group = "<!-- 06 -->Tests" },
  { message = "^style", group = "<!-- 07 -->Styling" },
  { message = "^build", group = "<!-- 08 -->Build System" },
  { message = "^ci", group = "<!-- 09 -->Continuous Integration" },
  # dependency bumps: both "chore(deps)" and dependabot's "chore: bump ..." pattern.
  { message = "^chore\\(deps\\)", group = "<!-- 10 -->Dependencies" },
  { message = "(?i)^chore.*: bump ", group = "<!-- 10 -->Dependencies" },
  # skip release prep commits
  { message = "^chore: [Pp]repare v", skip = true },
  { message = "^chore", group = "<!-- 11 -->Chores" },
  { message = ".*", group = "<!-- 12 -->Other Changes" },
]