Skip to content

Commit 062ce4d

Browse files
authored
docs(release): v1.32.0 release template improvements (#12874)
* docs(release): v1.32.0 release template improvements Accumulate release template improvements from shipping the v1.32.0 release: #12750 * Better crosslink between the release flow / release tool / release template.
1 parent 599deab commit 062ce4d

File tree

3 files changed

+24
-13
lines changed

3 files changed

+24
-13
lines changed

LOTUS_RELEASE_FLOW.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ These releases are not mandatory but are highly recommended, as they may contain
9191
* Lotus Miner: releases ship on an as-needed basis with no specified cadence. (See [Why isn't Lotus Miner released more frequently?](#why-isnt-lotus-miner-released-more-frequently))
9292

9393
## Release Process
94-
The specific steps executed for Lotus software releases are captured in the [Release Issue template](https://github.com/filecoin-project/lotus/blob/master/documentation/misc/RELEASE_ISSUE_TEMPLATE.md).
94+
The specific steps executed for Lotus software releases are captured in the [Release Issue template](./documentation/misc/RELEASE_ISSUE_TEMPLATE.md). `[cmd/release](./cmd/release/README.md) is used to help populate the template.
9595

9696
## Release Candidates (RCs)
9797

cmd/release/main.go

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,8 @@ func main() {
236236
},
237237
},
238238
Action: func(c *cli.Context) error {
239+
lotusReleaseCliString := strings.Join(os.Args, " ")
240+
239241
// Read and validate the flag values
240242
createOnGitHub := c.Bool("create-on-github")
241243

@@ -314,16 +316,17 @@ func main() {
314316

315317
// Prepare template data
316318
data := map[string]any{
317-
"CreateOnGitHub": createOnGitHub,
318-
"Type": releaseType,
319-
"Tag": releaseVersion.String(),
320-
"NextTag": releaseVersion.IncPatch().String(),
321-
"Level": releaseLevel,
322-
"NetworkUpgrade": networkUpgrade,
323-
"NetworkUpgradeDiscussionLink": discussionLink,
324-
"NetworkUpgradeChangelogEntryLink": changelogLink,
325-
"RC1DateString": rc1Date,
326-
"StableDateString": stableDate,
319+
"ContentGeneratedWithLotusReleaseCli": true,
320+
"LotusReleaseCliString": lotusReleaseCliString,
321+
"Type": releaseType,
322+
"Tag": releaseVersion.String(),
323+
"NextTag": releaseVersion.IncPatch().String(),
324+
"Level": releaseLevel,
325+
"NetworkUpgrade": networkUpgrade,
326+
"NetworkUpgradeDiscussionLink": discussionLink,
327+
"NetworkUpgradeChangelogEntryLink": changelogLink,
328+
"RC1DateString": rc1Date,
329+
"StableDateString": stableDate,
327330
}
328331

329332
// Render the issue template
@@ -380,6 +383,9 @@ URL to create issue:
380383
_, _ = fmt.Fprintf(c.App.Writer, debugFormat, issueTitle, issueBody, issueURL)
381384
} else {
382385
// Set up the GitHub client
386+
if os.Getenv("GITHUB_TOKEN") == "" {
387+
return fmt.Errorf("GITHUB_TOKEN environment variable must be set when using --create-on-github")
388+
}
383389
client := github.NewClient(nil).WithAuthToken(os.Getenv("GITHUB_TOKEN"))
384390

385391
// Check if the issue already exists

documentation/misc/RELEASE_ISSUE_TEMPLATE.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
[//]: # (Below are non-visible steps intended for the issue creator)
2+
<!--{{if .ContentGeneratedWithLotusReleaseCli}}-->
3+
[//]: # (This content was generated using `{{.LotusReleaseCliString}}`.)
4+
[//]: # (Learn more at https://github.com/filecoin-project/lotus/tree/master/cmd/release#readme.)
5+
<!--{{end}}-->
26
[//]: # (❗️ Complete the steps below as part of creating a release issue and mark them complete with an X or ✅ when done.)
3-
<!--{{if not .CreateOnGitHub}}-->
7+
<!--{{if not .ContentGeneratedWithLotusReleaseCli}}-->
48
[//]: # ([ ] Start an issue with title "Lotus {{.Type}} v{{.Tag}} Release" and adjust the title for whether it's a Node or Miner release.)
59
[//]: # ([ ] Copy in the content of https://github.com/filecoin-project/lotus/blob/master/documentation/misc/RELEASE_ISSUE_TEMPLATE.md)
610
[//]: # ([ ] Find all the "go templating" "control" logic that is in \{\{ \}\} blocks and mimic the logic manually.)
711
[//]: # ([ ] Adjust the "Meta" section values)
812
[//]: # ([ ] Apply the `tpm` label to the issue)
913
[//]: # ([ ] Create the issue)
1014
<!--{{end}}-->
11-
<!-- At least as of 2024-12-02, it isn't possible to programmatically pin issues. -->
15+
<!-- At least as of 2025-03-20, it isn't possible to programmatically pin issues. -->
1216
[//]: # ([ ] Pin the issue on GitHub)
1317

1418
# 😶‍🌫 Meta
@@ -170,6 +174,7 @@
170174
- 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.
171175
- [ ] 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.
172176
- [ ] 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.
177+
- [ ] Stage any security advisories for future publishing per [policy](https://github.com/filecoin-project/lotus/blob/master/LOTUS_RELEASE_FLOW.md#security-fix-policy).
173178
</details>
174179

175180
# ❤️ Contributors

0 commit comments

Comments
 (0)