Skip to content

Commit 99dcb12

Browse files
rjan90BigLep
andauthored
docs(release): v1.30.0, v1.31.0 and v1.31.1 release template improvements (#12563)
* docs(release): v1.30.0 and v1.31.0 release template improvements docs(release): v1.30.0 and v1.31.0 release template improvements * docs(release): v1.31.1 release template improvements docs(release): v1.31.1 release template improvements * Update RELEASE_ISSUE_TEMPLATE.md Co-authored-by: Steve Loeppky <[email protected]> * Update RELEASE_ISSUE_TEMPLATE.md Co-authored-by: Steve Loeppky <[email protected]> * chore: remove post-release step chore: remove post-release step --------- Co-authored-by: Steve Loeppky <[email protected]>
1 parent 18d1078 commit 99dcb12

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

documentation/misc/RELEASE_ISSUE_TEMPLATE.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,20 +45,25 @@
4545
# ✅ Release Checklist
4646

4747
## ⬅️ Before RC1
48+
<details one>
49+
<summary>Section</summary>
50+
4851
<!--{{if ne .NetworkUpgrade ""}}-->
4952
- [ ] Make sure all [Lotus dependencies are updated to the correct versions for the network upgrade](https://github.com/filecoin-project/lotus/blob/master/documentation/misc/Update_Dependencies_Lotus.md)
5053
- Link to Lotus PR:
5154
<!--{{end}}-->
5255
- [ ] Open PR against [RELEASE_ISSUE_TEMPLATE.md](https://github.com/filecoin-project/lotus/blob/master/documentation/misc/RELEASE_ISSUE_TEMPLATE.md) with title `docs(release): v{{.Tag}} release template improvements` for improving future releases.
5356
- Link to PR:
54-
- There likely aren't any changes at this point, but this can be opened with a small whitespace change so the PR is open and we can more easily hold the standard of making improvements incrementally since improvements are usually better done by collecting changes/notes along the way rather than just thinking about it at the end.
57+
- There likely aren't any changes at this point, but this can be opened with a small whitespace change so the PR is open and we can more easily hold the standard of making improvements incrementally since improvements are usually better done by collecting changes/notes along the way rather than just thinking about it at the end.
5558
- This will get merged in a `Post Release` step.
5659
<!--{{if eq .Level "patch"}})-->
5760
<!-- {{if contains "Node" .Type}}-->
58-
- [ ] Fork a new `release/v{{.Tag}}` branch from the last stable `release/vX.Y.x` and make any further release-related changes to this branch.
61+
- [ ] Fork a new `release/v{{.Tag}}` branch from the `master` branch and make any further release-related changes to this branch.
62+
- Note: For critical security patches, fork a new branch from the last stable `release/vX.Y.x` to expedite the release process.
5963
<!-- {{end}}-->
6064
<!-- {{if contains "Miner" .Type}}-->
61-
- [ ] Fork a new `release/miner/v{{.Tag}}` branch from the last stable `release/miner/vX.Y.x` and make any further release-related changes to this branch.
65+
- [ ] Fork a new `release/miner/v{{.Tag}}` branch from the `master` branch and make any further release-related changes to this branch.
66+
- Note: For critical security patches, fork a new branch from the last stable `release/vX.Y.x` to expedite the release process.
6267
<!-- {{end}}-->
6368
<!--{{end}}-->
6469
<!--{{if eq .Level "minor"}}-->
@@ -87,6 +92,7 @@
8792
- Link to PR:
8893
- [ ] Merge PR
8994
<!--{{end}}-->
95+
</details>
9096

9197
## 🏎️ RCs
9298

@@ -96,17 +102,20 @@
96102
<!-- {{$tagSuffix = printf "-%s" $rc}}-->
97103
<!-- {{end}}-->
98104
### {{$rc}}
105+
<details>
106+
<summary>Section</summary>
107+
99108
> [!IMPORTANT]
100109
> These PRs should be done in and target the `release/v{{$.Tag}}` or `release/miner/v{{$.Tag}}` branch.
101110
102111
#### Backport PR for {{$rc}}
103112
- [ ] All explicitly tracked items from `Dependencies for releases` have landed
104113
<!-- {{if ne $rc "rc1"}}-->
105114
- [ ] Backported [everything with the "backport" label](https://github.com/filecoin-project/lotus/issues?q=label%3Arelease%2Fbackport+)
106-
- [ ] Removed the "backport" label from all backported PRs (no ["backport" issues](https://github.com/filecoin-project/lotus/issues?q=label%3Arelease%2Fbackport+))
107115
- [ ] Create a PR with title `build: backport changes for {{$.Type}} v{{$.Tag}}{{$tagSuffix}}`
108116
- Link to PR:
109117
- [ ] Merge PR
118+
- [ ] Remove the "backport" label from all backported PRs (no ["backport" issues](https://github.com/filecoin-project/lotus/issues?q=label%3Arelease%2Fbackport+))
110119
<!-- {{end}}-->
111120

112121
#### Release PR for {{$rc}}
@@ -142,21 +151,26 @@
142151
- [ ] Merge the PR
143152
- Merging the PR will trigger a CI run that will build assets, attach the assets to the GitHub release, publish the GitHub release, and create the corresponding git tag.
144153
- [ ] Update `🚢 Estimated shipping date` table
145-
- [ ] Comment on this issue announcing the RC
154+
- [ ] Comment on this issue announcing the release:
146155
- Link to issue comment:
147156

148157
#### Testing for {{$rc}}
149158
> [!NOTE]
150159
> Link to any special steps for testing releases beyond ensuring CI is green. Steps can be inlined here or tracked elsewhere.
151160
152161
<!--{{end}}-->
162+
</details>
153163

154164
## ➡ Post-Release
165+
<details>
166+
<summary open>Section</summary>
155167

156168
- [ ] Open a PR against `master` cherry-picking the CHANGELOG commits from the `release/v{{.Tag}}` branch. Title it `chore(release): cherry-pick v{{.Tag}} changelog back to master`
157169
- Link to PR:
158170
- Assuming we followed [the process of merging changes into `master` first before backporting to the release branch](https://github.com/filecoin-project/lotus/blob/master/LOTUS_RELEASE_FLOW.md#branch-and-tag-strategy), the only changes should be CHANGELOG updates.
159171
- [ ] Finish updating/merging the [RELEASE_ISSUE_TEMPLATE.md](https://github.com/filecoin-project/lotus/blob/master/documentation/misc/RELEASE_ISSUE_TEMPLATE.md) PR from `Before RC1` with any improvements determined from this latest release iteration.
172+
- [ ] Review and approve the auto-generated PR in [lotus-docs](https://github.com/filecoin-project/lotus-docs/pulls) that updates the latest Lotus version information.
173+
</details>
160174

161175
# ❤️ Contributors
162176

0 commit comments

Comments
 (0)