6
6
# Automatically label PRs based on their branch, title, or changed files.
7
7
# This helps categorise PRs in the CHANGELOG.
8
8
autolabeler :
9
- - label : ' C-security'
9
+ - label : " C-security"
10
10
branch :
11
- - ' /secur/i'
11
+ - " /secur/i"
12
12
title :
13
- - ' /secur/i'
14
- - ' /crash/i'
15
- - ' /destr/i'
16
- - ' /unsafe/i'
17
- - label : ' C-deprecated'
13
+ - " /secur/i"
14
+ - " /crash/i"
15
+ - " /destr/i"
16
+ - " /unsafe/i"
17
+ - label : " C-deprecated"
18
18
branch :
19
- - ' /deprecat/i'
19
+ - " /deprecat/i"
20
20
title :
21
- - ' /deprecat/i'
22
- - label : ' extra-reviews'
21
+ - " /deprecat/i"
22
+ - label : " extra-reviews"
23
23
branch :
24
- - ' /remov/i'
25
- - ' /deprecat/i'
24
+ - " /remov/i"
25
+ - " /deprecat/i"
26
26
title :
27
- - ' /remov/i'
28
- - ' /deprecat/i'
29
- - ' /crash/i'
30
- - ' /destr/i'
31
- - ' /unsafe/i'
32
- - label : ' C-feature'
27
+ - " /remov/i"
28
+ - " /deprecat/i"
29
+ - " /crash/i"
30
+ - " /destr/i"
31
+ - " /unsafe/i"
32
+ - label : " C-feature"
33
33
branch :
34
- - ' /feat/i'
34
+ - " /feat/i"
35
35
title :
36
- - ' /feat/i'
37
- - label : ' C-bug'
36
+ - " /feat/i"
37
+ - label : " C-bug"
38
38
branch :
39
- - ' /bug/i'
39
+ - " /bug/i"
40
40
title :
41
- - ' /bug/i'
42
- # Changes that are almost always trivial for users
43
- - label : ' C-trivial'
44
- branch :
45
- - ' /clean/i'
46
- - ' /chore/i'
47
- - ' /clippy/i'
48
- - ' /test/i'
49
- title :
50
- - ' /clean/i'
51
- - ' /chore/i'
52
- - ' /clippy/i'
53
- - ' /test/i'
54
- - ' /(ci)/i'
55
- - ' /(cd)/i'
56
- - ' /job/i'
57
- - ' /patch/i'
58
- - ' /actions/i'
59
- files :
60
- # Regular changes that don't need to go in the CHANGELOG
61
- - ' CHANGELOG.md'
62
- - ' zebra-consensus/src/checkpoint/*-checkpoints.txt'
63
- # Developer-only changes
64
- - ' .gitignore'
65
- - ' .dockerignore'
66
- # Test-only changes
67
- - ' zebra-test'
68
- - ' .cargo/config.toml'
69
- - ' clippy.toml'
70
- # CI-only changes
71
- - ' .github'
72
- - ' .codespellrc'
73
- - ' codecov.yml'
74
- - ' deny.toml'
41
+ - " /bug/i"
75
42
76
43
# The release name, tag, and settings for the draft CHANGELOG.
77
- name-template : ' Zebra $RESOLVED_VERSION'
78
- tag-template : ' v$RESOLVED_VERSION'
79
- tag-prefix : ' v '
44
+ name-template : " Zebra $RESOLVED_VERSION"
45
+ tag-template : " v$RESOLVED_VERSION"
46
+ tag-prefix : " v "
80
47
# Do not mark the draft release as a pre-release
81
48
prerelease : false
82
49
# Do not include pre-releases in the draft release
83
50
include-pre-releases : false
84
51
85
52
# Categories in rough order of importance to users.
86
53
# Based on https://keepachangelog.com/en/1.0.0/
87
- category-template : ' ### $TITLE'
54
+ category-template : " ### $TITLE"
88
55
categories :
89
- - title : ' Security'
56
+ - title : " Security"
90
57
labels :
91
- - ' C-security'
58
+ - " C-security"
92
59
# Other labels that are usually security issues
93
- - ' I-invalid-data'
94
- - ' I-consensus'
95
- - ' I-crash'
96
- - ' I-destructive'
97
- - ' I-hang'
98
- - ' I-lose-funds'
99
- - ' I-privacy'
100
- - ' I-remote-node-overload'
101
- - ' I-unbounded-growth'
102
- - ' I-memory-safety'
103
- - title : ' Removed'
60
+ - " I-invalid-data"
61
+ - " I-consensus"
62
+ - " I-crash"
63
+ - " I-destructive"
64
+ - " I-hang"
65
+ - " I-lose-funds"
66
+ - " I-privacy"
67
+ - " I-remote-node-overload"
68
+ - " I-unbounded-growth"
69
+ - " I-memory-safety"
70
+ - title : " Removed"
104
71
labels :
105
- - ' C-removal'
106
- - title : ' Deprecated'
72
+ - " C-removal"
73
+ - title : " Deprecated"
107
74
labels :
108
- - ' C-deprecation'
75
+ - " C-deprecation"
109
76
# TODO: when release drafter has per-category templates, add this to the Deprecated category template:
110
77
# 'These features might be removed in Zebra $NEXT_MINOR_VERSION'
111
- - title : ' Added'
78
+ - title : " Added"
112
79
labels :
113
- - ' C-feature'
114
- - title : ' Changed'
80
+ - " C-feature"
81
+ - title : " Changed"
115
82
labels :
116
- - ' C-enhancement'
117
- - title : ' Fixed'
83
+ - " C-enhancement"
84
+ - title : " Fixed"
118
85
labels :
119
- - ' C-bug'
86
+ - " C-bug"
120
87
# Other labels that are usually bugs
121
- - ' I-build-fail'
122
- - ' I-integration-fail'
123
- - ' I-panic'
124
- # TODO: if we're happy with the trivial PRs, use "exclude-labels:" instead
125
- - title : ' Trivial *TODO:* put this in a PR comment, not the CHANGELOG'
88
+ - " I-build-fail"
89
+ - " I-integration-fail"
90
+ - " I-panic"
91
+ - title : " Excluded *TODO:* put this in a PR comment, not the CHANGELOG"
126
92
labels :
127
- - ' C-trivial'
128
- - ' C-cleanup'
93
+ - " C-exclude-from-changelog"
129
94
130
95
# The next release's $RESOLVED_VERSION, based on the labels of the PRs in the release.
131
96
#
@@ -139,15 +104,15 @@ version-resolver:
139
104
# - # network upgrade release PRs
140
105
minor :
141
106
labels :
142
- - ' C-feature'
143
- - ' C-breaking'
144
- - ' C-removal'
145
- - ' C-deprecation'
107
+ - " C-feature"
108
+ - " C-breaking"
109
+ - " C-removal"
110
+ - " C-deprecation"
146
111
# We increment the patch version for every release
147
112
default : patch
148
113
149
114
# How PR names get turned into CHANGELOG entries.
150
- change-template : ' - $TITLE ([#$NUMBER]($URL))'
115
+ change-template : " - $TITLE ([#$NUMBER]($URL))"
151
116
sort-by : title
152
117
sort-direction : ascending
153
118
# Characters escaped when converting PR titles to CHANGELOG entries.
@@ -156,31 +121,30 @@ change-title-escapes: '\<*_&#@'
156
121
# Strip PR series numbers, leading spaces, and conventional commit prefixes from PR titles.
157
122
replacers :
158
123
- search : ' /- [0-9\. ]*([a-zA-Z0-9\(\)!]+:)?/'
159
- replace : ' - '
124
+ replace : " - "
160
125
161
126
# The list of contributors to each release.
162
127
exclude-contributors :
163
- - ' dependabot' # 'dependabot[bot]'
164
- - ' mergifyio' # 'mergify[bot]'
128
+ - " dependabot" # 'dependabot[bot]'
129
+ - " mergifyio" # 'mergify[bot]'
165
130
166
131
# The template for the draft CHANGELOG.
167
132
template : |
168
133
## [Zebra $RESOLVED_VERSION](https://github.com/ZcashFoundation/zebra/releases/tag/v$RESOLVED_VERSION) - *TODO*: date
169
-
134
+
170
135
This release *TODO*: a summary of the significant user-visible changes in the release
171
-
136
+
172
137
### Breaking Changes
173
-
138
+
174
139
This release has the following breaking changes:
175
140
- *TODO*: Check the `Removed` and `Deprecated` sections for any breaking changes
176
141
- *TODO*: Add a short description of the user impact of each breaking change, and any actions users need to take
177
-
142
+
178
143
$CHANGES
179
-
144
+
180
145
### Contributors
181
-
146
+
182
147
Thank you to everyone who contributed to this release, we couldn't make Zebra without you:
183
148
$CONTRIBUTORS
184
-
185
-
149
+
186
150
# the trailing newlines in the template are deliberate
0 commit comments