Skip to content

Commit 361fa65

Browse files
upbqdnmpguerra
andauthored
chore: Update the PR template (#9277)
* Update PR template * Don't automatically assign the `C-trivial` label * Use `C-exclude-from-changelog` label * Simplify the PR template * Simplify the PR template * Simplify the PR template * Update .github/pull_request_template.md Co-authored-by: Pili Guerra <[email protected]> * grammar --------- Co-authored-by: Pili Guerra <[email protected]>
1 parent c4e8e60 commit 361fa65

File tree

5 files changed

+93
-137
lines changed

5 files changed

+93
-137
lines changed

.github/ISSUE_TEMPLATE/release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: "🚀 Zebra Release"
33
about: 'Zebra team use only'
44
title: 'Publish next Zebra release: (version)'
5-
labels: 'A-release, C-trivial, P-Medium :zap:'
5+
labels: 'A-release, C-exclude-from-changelog, P-Medium :zap:'
66
assignees: ''
77

88
---

.github/PULL_REQUEST_TEMPLATE/release-checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: 'Release Checklist Template'
33
about: 'Checklist to create and publish a Zebra release'
44
title: 'Release Zebra (version)'
5-
labels: 'A-release, C-trivial, P-Critical :ambulance:'
5+
labels: 'A-release, C-exclude-from-changelog, P-Critical :ambulance:'
66
assignees: ''
77

88
---

.github/dependabot.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ updates:
1111
# Limit dependabot to 1 PR per reviewer
1212
open-pull-requests-limit: 6
1313
labels:
14-
- 'C-trivial'
14+
- 'C-exclude-from-changelog'
1515
- 'A-rust'
1616
- 'A-dependencies'
1717
- 'P-Low :snowflake:'
@@ -46,7 +46,7 @@ updates:
4646
timezone: America/New_York
4747
open-pull-requests-limit: 4
4848
labels:
49-
- 'C-trivial'
49+
- 'C-exclude-from-changelog'
5050
- 'A-devops'
5151
- 'A-dependencies'
5252
- 'P-Low :snowflake:'

.github/pull_request_template.md

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,46 @@
1-
## Motivation
2-
31
<!--
4-
- Describe the goals of the PR.
5-
- If it closes any issues, list them here.
2+
- Use this template to quickly write the PR description.
3+
- Skip or delete items that don't fit.
64
-->
75

8-
### Specifications & References
6+
## Motivation
97

108
<!--
11-
- Provide references related to the PR.
9+
- Describe the goals of the PR.
10+
- If it closes any issues, enumerate them here.
1211
-->
1312

1413
## Solution
1514

16-
<!--
17-
- Summarize or list the changes in the PR.
18-
-->
15+
<!-- Describe the changes in the PR. -->
1916

2017
### Tests
2118

2219
<!--
23-
- Describe how the solution in this PR is tested:
20+
- Describe how you tested the solution:
2421
- Describe any manual or automated tests.
25-
- If the solution can't be tested, explain why.
22+
- If you could not test the solution, explain why.
2623
-->
2724

25+
### Specifications & References
26+
27+
<!-- Provide any relevant references. -->
28+
2829
### Follow-up Work
2930

3031
<!--
31-
- Describe or list what's missing from the solution.
32-
- List any follow-up issues.
33-
- If this PR blocks or is blocked by any other work, provide a description, or
34-
list the related issues.
32+
- If there's anything missing from the solution, describe it here.
33+
- List any follow-up issues or PRs.
34+
- If this PR blocks or depends on other issues or PRs, enumerate them here.
3535
-->
3636

37-
### PR Author's Checklist
37+
### PR Checklist
3838

39-
<!-- If you are the author of the PR, check the boxes below before making the PR
40-
ready for review. -->
39+
<!-- Check as many boxes as possible. -->
4140

42-
- [ ] The PR name will make sense to users.
43-
- [ ] The PR provides a CHANGELOG summary.
41+
- [ ] The PR name is suitable for the release notes.
4442
- [ ] The solution is tested.
4543
- [ ] The documentation is up to date.
4644
- [ ] The PR has a priority label.
47-
48-
### PR Reviewer's Checklist
49-
50-
<!-- If you are a reviewer of the PR, check the boxes below before approving it. -->
51-
52-
- [ ] The PR Author's checklist is complete.
53-
- [ ] The PR resolves the issue.
54-
45+
- [ ] If the PR shouldn't be in the release notes, it has the
46+
`C-exclude-from-changelog` label.

.github/release-drafter.yml

Lines changed: 69 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -6,126 +6,91 @@
66
# Automatically label PRs based on their branch, title, or changed files.
77
# This helps categorise PRs in the CHANGELOG.
88
autolabeler:
9-
- label: 'C-security'
9+
- label: "C-security"
1010
branch:
11-
- '/secur/i'
11+
- "/secur/i"
1212
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"
1818
branch:
19-
- '/deprecat/i'
19+
- "/deprecat/i"
2020
title:
21-
- '/deprecat/i'
22-
- label: 'extra-reviews'
21+
- "/deprecat/i"
22+
- label: "extra-reviews"
2323
branch:
24-
- '/remov/i'
25-
- '/deprecat/i'
24+
- "/remov/i"
25+
- "/deprecat/i"
2626
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"
3333
branch:
34-
- '/feat/i'
34+
- "/feat/i"
3535
title:
36-
- '/feat/i'
37-
- label: 'C-bug'
36+
- "/feat/i"
37+
- label: "C-bug"
3838
branch:
39-
- '/bug/i'
39+
- "/bug/i"
4040
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"
7542

7643
# 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"
8047
# Do not mark the draft release as a pre-release
8148
prerelease: false
8249
# Do not include pre-releases in the draft release
8350
include-pre-releases: false
8451

8552
# Categories in rough order of importance to users.
8653
# Based on https://keepachangelog.com/en/1.0.0/
87-
category-template: '### $TITLE'
54+
category-template: "### $TITLE"
8855
categories:
89-
- title: 'Security'
56+
- title: "Security"
9057
labels:
91-
- 'C-security'
58+
- "C-security"
9259
# 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"
10471
labels:
105-
- 'C-removal'
106-
- title: 'Deprecated'
72+
- "C-removal"
73+
- title: "Deprecated"
10774
labels:
108-
- 'C-deprecation'
75+
- "C-deprecation"
10976
# TODO: when release drafter has per-category templates, add this to the Deprecated category template:
11077
# 'These features might be removed in Zebra $NEXT_MINOR_VERSION'
111-
- title: 'Added'
78+
- title: "Added"
11279
labels:
113-
- 'C-feature'
114-
- title: 'Changed'
80+
- "C-feature"
81+
- title: "Changed"
11582
labels:
116-
- 'C-enhancement'
117-
- title: 'Fixed'
83+
- "C-enhancement"
84+
- title: "Fixed"
11885
labels:
119-
- 'C-bug'
86+
- "C-bug"
12087
# 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"
12692
labels:
127-
- 'C-trivial'
128-
- 'C-cleanup'
93+
- "C-exclude-from-changelog"
12994

13095
# The next release's $RESOLVED_VERSION, based on the labels of the PRs in the release.
13196
#
@@ -139,15 +104,15 @@ version-resolver:
139104
# - # network upgrade release PRs
140105
minor:
141106
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"
146111
# We increment the patch version for every release
147112
default: patch
148113

149114
# How PR names get turned into CHANGELOG entries.
150-
change-template: '- $TITLE ([#$NUMBER]($URL))'
115+
change-template: "- $TITLE ([#$NUMBER]($URL))"
151116
sort-by: title
152117
sort-direction: ascending
153118
# Characters escaped when converting PR titles to CHANGELOG entries.
@@ -156,31 +121,30 @@ change-title-escapes: '\<*_&#@'
156121
# Strip PR series numbers, leading spaces, and conventional commit prefixes from PR titles.
157122
replacers:
158123
- search: '/- [0-9\. ]*([a-zA-Z0-9\(\)!]+:)?/'
159-
replace: '- '
124+
replace: "- "
160125

161126
# The list of contributors to each release.
162127
exclude-contributors:
163-
- 'dependabot' # 'dependabot[bot]'
164-
- 'mergifyio' # 'mergify[bot]'
128+
- "dependabot" # 'dependabot[bot]'
129+
- "mergifyio" # 'mergify[bot]'
165130

166131
# The template for the draft CHANGELOG.
167132
template: |
168133
## [Zebra $RESOLVED_VERSION](https://github.com/ZcashFoundation/zebra/releases/tag/v$RESOLVED_VERSION) - *TODO*: date
169-
134+
170135
This release *TODO*: a summary of the significant user-visible changes in the release
171-
136+
172137
### Breaking Changes
173-
138+
174139
This release has the following breaking changes:
175140
- *TODO*: Check the `Removed` and `Deprecated` sections for any breaking changes
176141
- *TODO*: Add a short description of the user impact of each breaking change, and any actions users need to take
177-
142+
178143
$CHANGES
179-
144+
180145
### Contributors
181-
146+
182147
Thank you to everyone who contributed to this release, we couldn't make Zebra without you:
183148
$CONTRIBUTORS
184-
185-
149+
186150
# the trailing newlines in the template are deliberate

0 commit comments

Comments
 (0)