Repository navigation
Expand file tree
/
Copy pathcliff.toml
More file actions
75 lines (66 loc) · 3.1 KB
/
Copy pathcliff.toml
File metadata and controls
75 lines (66 loc) · 3.1 KB
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
# SPDX-License-Identifier: Apache-2.0
# SPDX-FileCopyrightText: See the NOTICE file distributed with this work for additional information regarding copyright ownership
# SPDX-FileContributor: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration
[remote.github]
# For token set GITHUB_TOKEN env var or pass via --github-token
owner = "apache"
repo = "arrow-rs"
[changelog]
# Otherwise it removes the left padding in the license header
trim = false
header = """
<!---
SPDX-License-Identifier: Apache-2.0
SPDX-FileCopyrightText: See the NOTICE file distributed with this work for additional information regarding copyright ownership
SPDX-FileContributor: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements
-->
# Changelog
"""
body = """
{%- macro remote_url() -%}
https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
{%- endmacro -%}
{% if version %}
## [{{ version }}]({{ self::remote_url() }}/tree/{{ version }}) - ({{ timestamp | date(format="%Y-%m-%d") }})
{% else %}
## [unreleased]
{% endif %}
[Full Changelog]({{ self::remote_url() }}/compare/{{ previous.version }}...{{ version }})
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | striptags | trim | upper_first }}
{%- for commit in commits %}
- {% if commit.remote.pr_title %}{{ commit.remote.pr_title | trim }}{% else %}{{ commit.message | split(pat="\n") | first | upper_first | trim }}{% endif %}\
{% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif -%}
{% if commit.remote.pr_number %} in \
[#{{ commit.remote.pr_number }}]({{ self::remote_url() }}/pull/{{ commit.remote.pr_number }}) \
{%- endif -%}
{% endfor %}
{% endfor %}
"""
[git]
# We don't use conventional commits
conventional_commits = false
filter_unconventional = false
require_conventional = false
# To make backport releases easier
use_branch_tags = true
# Ignoring rc tags
tag_pattern = "^\\d+\\.\\d+\\.\\d+$"
commit_parsers = [
# Grouping based on PR labels
{ field = "remote.pr_labels", pattern = "api-change", group = "<!-- 0 -->Breaking changes" },
{ field = "remote.pr_labels", pattern = "security", group = "<!-- 1 -->Security fixes" },
{ field = "remote.pr_labels", pattern = "enhancement", group = "<!-- 2 -->Enhancements" },
{ field = "remote.pr_labels", pattern = "bug", group = "<!-- 3 -->Bug fixes" },
{ field = "remote.pr_labels", pattern = "performance", group = "<!-- 4 -->Performance improvements" },
{ field = "remote.pr_labels", pattern = "documentation", group = "<!-- 5 -->Documentation updates" },
{ field = "remote.pr_labels", pattern = "development-process", skip = true },
# We could have a visible section for dependency updates if we want
{ field = "remote.pr_labels", pattern = "auto-dependencies", skip = true },
# Ideally we minimize this last section as much as possible by ensuring PRs
# are labelled as above
{ message = ".*", group = "<!-- 6 -->Miscellaneous" },
]
sort_commits = "newest"