chore: hide manual steps now that commands request them themselves
galargh committed
Jan 31, 2023 at 14:31 UTC
bcf446d1a1478e863f98e5f3af3d569d68e30a6e
1 file changed
+18
-15
docs/RELEASE_ISSUE_TEMPLATE.md
+18
-15
@@ -76,7 +76,7 @@ This section covers tasks to be done ahead of the release.
76
- [example](https://github.com/ipfs/distributions/pull/756)
77
- [ ]  [ipfs/ipfs-docs](https://github.com/ipfs/ipfs-docs)
78
- [example](https://github.com/ipfs/ipfs-docs/pull/1298)
79
-- [ ] Notify the bifrost team about the upcoming release <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) notify-bifrost --date YYYY-MM-DD` or ...</summary> (_only if it is not the day of the release yet_)
79
+- [ ] Notify the bifrost team about the upcoming release (_only if it is not the day of the release yet_) <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) notify-bifrost --date YYYY-MM-DD` or ...</summary>
80
- [ ] open an issue against [bifrost-infra](https://github.com/protocol/bifrost-infra)
81
- [example](https://github.com/protocol/bifrost-infra/issues/2221)
82
</details>
@@ -94,21 +94,21 @@ This section covers tasks to be done during each release.
94
- [ ] create a new branch `release-vX.Y.Z`
95
- use `master` as base if `Z == 0`
96
- use `release` as base if `Z > 0`
97
- - [ ]  update the `CurrentVersionNumber` in [version.go](version.go) in the `master` branch to `vX.(Y+1).0-dev`
97
+ - [ ]  update the `CurrentVersionNumber` in [version.go](version.go) in the `master` branch to `vX.Y+1.0-dev`
98
- [example](https://github.com/ipfs/kubo/pull/9305)
99
- [ ] update the `CurrentVersionNumber` in [version.go](version.go) in the `release-vX.Y` branch to `vX.Y.Z(-RCN)`
100
- [example](https://github.com/ipfs/kubo/pull/9394)
101
- [ ] create a draft PR from `release-vX.Y` to `release`
102
- [example](https://github.com/ipfs/kubo/pull/9306)
103
+ - [ ] Cherry-pick commits from `master` to the `release-vX.Y.Z` using `git cherry-pick -x <commit>`
104
+ - [ ]  Add full changelog and contributors to the [changelog](docs/changelogs/vX.Y.md)
105
+ - [ ]  Replace the `Changelog` and `Contributors` sections of the [changelog](docs/changelogs/vX.Y.md) with the stdout of `./bin/mkreleaselog`
106
+ - do **NOT** copy the stderr
107
- [ ] verify all CI checks on the PR from `release-vX.Y` to `release` are passing
108
+ - [ ]  Merge the PR from `release-vX.Y` to `release` using the `Create a merge commit`
109
+ - do **NOT** use `Squash and merge` nor `Rebase and merge` because we need to be able to sign the merge commit
110
+ - do **NOT** delete the `release-vX.Y` branch
111
</details>
105
-- [ ] Cherry-pick commits from `master` to the `release-vX.Y.Z` using `git cherry-pick -x <commit>`
106
-- [ ]  Add full changelog and contributors to the [changelog](docs/changelogs/vX.Y.md)
107
- - [ ]  Replace the `Changelog` and `Contributors` sections of the [changelog](docs/changelogs/vX.Y.md) with the stdout of `./bin/mkreleaselog`
108
- - do **NOT** copy the stderr
109
-- [ ]  Merge the PR from `release-vX.Y` to `release` using the `Create a merge commit`
110
- - do **NOT** use `Squash and merge` nor `Rebase and merge` because we need to be able to sign the merge commit
111
- - do **NOT** delete the `release-vX.Y` branch
112
- [ ] Create the release tag <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) tag` or ...</summary>
113
- This is a dangerous operation! Go and Docker publishing are difficult to reverse! Have the release reviewer verify all the commands marked with ⚠️!
114
- [ ] ⚠️  tag the HEAD commit using `git tag -s vX.Y.Z(-RCN) -m 'Prerelease X.Y.Z(-RCN)'`
@@ -117,7 +117,8 @@ This section covers tasks to be done during each release.
117
- [ ] ⚠️ push the tag to GitHub using `git push origin vX.Y.Z(-RCN)`
118
- do **NOT** use `git push --tags` because it pushes all your local tags
119
</details>
120
-- [ ] Wait for [Publish docker image](https://github.com/ipfs/kubo/actions/workflows/docker-image.yml) workflow run initiated by the tag push to finish
120
+- [ ] Publish the release to [DockerHub](https://hub.docker.com/r/ipfs/kubo/) <details><summary>using `kuboreleaser --skip-check-before --skip-run release --version vX.Y.Z(-RCN) publish-to-dockerhub` or ...</summary>
121
+ - [ ] Wait for [Publish docker image](https://github.com/ipfs/kubo/actions/workflows/docker-image.yml) workflow run initiated by the tag push to finish
122
- [ ] verify the image is available on [Docker Hub](https://hub.docker.com/r/ipfs/kubo/tags)
123
- [ ] Publish the release to [ipfs.tech](https://dist.ipfs.tech) <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) publish-to-distributions` or ...</summary>
124
- [ ] check out [ipfs/distributions](https://github.com/ipfs/distributions)
@@ -164,6 +165,8 @@ This section covers tasks to be done during each release.
165
- [ ] [#ipfs-chatter](https://discord.com/channels/669268347736686612/669268347736686615) in IPFS Discord
166
- [ ] [#ipfs-chatter](https://filecoinproject.slack.com/archives/C018EJ8LWH1) in FIL Slack
167
- [ ] [#ipfs-chatter:ipfs.io](https://matrix.to/#/#ipfs-chatter:ipfs.io) in Matrix
168
+ - [ ]  Add the link to the [IPFS Discourse](https://discuss.ipfs.tech) topic to the [GitHub Release](https://github.com/ipfs/kubo/releases/tag/vX.Y.Z(-RCN)) description
169
+ - [example](https://github.com/ipfs/kubo/releases/tag/v0.17.0)
170
- [ ]  create an issue comment mentioning early testers on the release issue
171
- [example](https://github.com/ipfs/kubo/issues/9319#issuecomment-1311002478)
172
- [ ]  create an issue comment linking to the release on the release issue
@@ -173,8 +176,6 @@ This section covers tasks to be done during each release.
176
- [ ]   post the link to the [GitHub Release](https://github.com/ipfs/kubo/releases/tag/vX.Y.Z(-RCN)) to [Reddit](https://reddit.com/r/ipfs)
177
- [example](https://www.reddit.com/r/ipfs/comments/9x0q0k/kubo_v0160_release_is_out/)
178
</details>
176
-- [ ]  Add the link to the [IPFS Discourse](https://discuss.ipfs.tech) topic to the [GitHub Release](https://github.com/ipfs/kubo/releases/tag/vX.Y.Z(-RCN)) description
177
- - [example](https://github.com/ipfs/kubo/releases/tag/v0.17.0)
179
- [ ] Test the new version with `ipfs-companion` <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) test-ipfs-companion` or ...</summary>
180
- [ ] run the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml)
181
- use `vX.Y.Z(-RCN)` as the Kubo image version
@@ -209,9 +210,11 @@ This section covers tasks to be done during each release.
210
- [ ] create a new branch `merge-release-vX.Y.Z` from `release`
211
- [ ] create and merge a PR from `merge-release-vX.Y.Z` to `master`
212
</details>
212
-- [ ]   Create the next [changelog](https://github.com/ipfs/kubo/blob/master/docs/changelogs/vX.(Y+1).md)
213
- - link to the new changelog in the [CHANGELOG.md](CHANGELOG.md) file
214
-- [ ]   Create the next release issue
213
+- [ ]   Prepare for the next release <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) prepare-next` or ...</summary>
214
+ - [ ]   Create the next [changelog](https://github.com/ipfs/kubo/blob/master/docs/changelogs/vX.(Y+1).md)
215
+ - [ ]   Link to the new changelog in the [CHANGELOG.md](CHANGELOG.md) file
216
+ - [ ]   Create the next release issue
217
+ </details>
218
- [ ]   Create a dependency update PR
219
- [ ]   check out [ipfs/kubo](https://github.com/ipfs/kubo)
220
- [ ]   run `go get -t -u ./...`