chore: hide release instructions which can be skipped
galargh committed
Jan 26, 2023 at 17:00 UTC
a567ac52bae16bf16e428a598f14864c1c45bdee
1 file changed
+35
-18
docs/RELEASE_ISSUE_TEMPLATE.md
+35
-18
@@ -77,10 +77,11 @@ This section covers tasks to be done ahead of the release.
77
- [example](https://github.com/ipfs/distributions/pull/756)
78
- [ ] [ipfs/ipfs-docs](https://github.com/ipfs/ipfs-docs)
79
- [example](https://github.com/ipfs/ipfs-docs/pull/1298)
80
-- [ ] Notify the bifrost team about the upcoming release using `kuboreleaser release --version vX.Y.Z(-RCN) notify-bifrost --date YYYY-MM-DD`
80
+- [ ] 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>
81
- [ ] open an issue against [bifrost-infra](https://github.com/protocol/bifrost-infra)
82
- [example](https://github.com/protocol/bifrost-infra/issues/2221)
83
- - [ ] link the issue in the [Meta](#meta) section
83
+ </details>
84
+- [ ] Link the [bifrost-infra](https://github.com/protocol/bifrost-infra) issue in the [Meta](#meta) section
85
- [ ] Verify there is nothing [left for release](-what-s-left-for-release)
86
- [ ] Create a release process improvement PR
87
- [ ] update the [release issue template](docs/RELEASE_ISSUE_TEMPLATE.md) as you go
@@ -90,7 +91,7 @@ This section covers tasks to be done ahead of the release.
91
92
This section covers tasks to be done during each release.
93
93
-- [ ] Cut the release branch and update version numbers accordingly using `kuboreleaser release --version vX.Y.Z(-RCN) cut-branch`
94
+- [ ] Cut the release branch and update version numbers accordingly <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) cut-branch` or ...</summary>
95
- [ ] create a new branch `release-vX.Y.Z`
96
- use `master` as base if `Z == 0`
97
- use `release` as base if `Z > 0`
@@ -101,21 +102,25 @@ This section covers tasks to be done during each release.
102
- [ ] create a draft PR from `release-vX.Y` to `release`
103
- [example](https://github.com/ipfs/kubo/pull/9306)
104
- [ ] verify all CI checks on the PR from `release-vX.Y` to `release` are passing
105
+ </details>
106
- [ ] Cherry-pick commits from `master` to the `release-vX.Y.Z` using `git cherry-pick -x <commit>`
107
- [ ]  Add full changelog and contributors to the [changelog](docs/changelogs/vX.Y.md)
108
+ - [ ]  Paste the stdout of `./bin/mkreleaselog` at the end of the [changelog](docs/changelogs/vX.Y.md)
109
+ - do **NOT** copy the stderr
110
- [ ]  Merge the PR from `release-vX.Y` to `release` using the `Create a merge commit`
111
- do **NOT** use `Squash and merge` nor `Rebase and merge` because we need to be able to sign the merge commit
112
- do **NOT** delete the `release-vX.Y` branch
109
-- [ ] Create the release tag using `kuboreleaser release --version vX.Y.Z(-RCN) tag`
113
+- [ ] Create the release tag <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) tag` or ...</summary>
114
- This is a dangerous operation! Go and Docker publishing are difficult to reverse! Have the release reviewer verify all the commands marked with ⚠️!
111
- - [ ]  ⚠️ tag the HEAD commit using `git tag -s vX.Y.Z(-RCN) -m 'Prerelease X.Y.Z(-RCN)'`
112
- - [ ]  ⚠️ tag the HEAD commit of the `release` branch using `git tag -s vX.Y.Z(-RCN) -m 'Release X.Y.Z(-RCN)'`
115
+ - [ ] ⚠️  tag the HEAD commit using `git tag -s vX.Y.Z(-RCN) -m 'Prerelease X.Y.Z(-RCN)'`
116
+ - [ ] ⚠️  tag the HEAD commit of the `release` branch using `git tag -s vX.Y.Z(-RCN) -m 'Release X.Y.Z(-RCN)'`
117
- [ ] ⚠️ verify the tag is signed and tied to the correct commit using `git show vX.Y.Z(-RCN)`
118
- [ ] ⚠️ push the tag to GitHub using `git push origin vX.Y.Z(-RCN)`
119
- do **NOT** use `git push --tags` because it pushes all your local tags
120
+ </details>
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)
118
-- [ ] Publish the release to [ipfs.tech](https://dist.ipfs.tech) using `kuboreleaser release --version vX.Y.Z(-RCN) publish-to-distributions`
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)
125
- [ ] run `./dist.sh add-version kubo vX.Y.Z(-RCN)` to add the new version to the `versions` file
126
- [usage](https://github.com/ipfs/distributions#usage)
@@ -123,11 +128,13 @@ This section covers tasks to be done during each release.
128
- [example](https://github.com/ipfs/distributions/pull/760)
129
- [ ] wait for the [CI](https://github.com/ipfs/distributions/actions/workflows/main.yml) workflow run initiated by the merge to master to finish
130
- [ ] verify the release is available on [dist.ipfs.io](https://dist.ipfs.io/#kubo)
126
-- [ ] Publish the release to [NPM](https://www.npmjs.com/package/go-ipfs?activeTab=versions) using `kuboreleaser release --version vX.Y.Z(-RCN) publish-to-npm`
131
+ </details>
132
+- [ ] Publish the release to [NPM](https://www.npmjs.com/package/go-ipfs?activeTab=versions) <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) publish-to-npm` or ...</summary>
133
- [ ] run the [Release to npm](https://github.com/ipfs/npm-go-ipfs/actions/workflows/main.yml) workflow
134
- [ ] check [Release to npm](https://github.com/ipfs/npm-go-ipfs/actions/workflows/main.yml) workflow run logs to verify it discovered the new release
135
- [ ] verify the release is available on [NPM](https://www.npmjs.com/package/go-ipfs?activeTab=versions)
130
-- [ ] Publish the release to [GitHub](https://github.com/ipfs/kubo/releases) using `kuboreleaser release --version vX.Y.Z(-RCN) publish-to-github`
136
+ </details>
137
+- [ ] Publish the release to [GitHub](https://github.com/ipfs/kubo/releases) <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) publish-to-github` or ...</summary>
138
- [ ] create a new release on [GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release)
139
- [RC example](https://github.com/ipfs/kubo/releases/tag/v0.17.0-rc1)
140
- [FINAL example](https://github.com/ipfs/kubo/releases/tag/v0.17.0)
@@ -140,9 +147,11 @@ This section covers tasks to be done during each release.
147
- [ ] run the [sync-release-assets](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) workflow
148
- [ ] wait for the [sync-release-assets](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) workflow run to finish
149
- [ ] verify the release assets are present in the [GitHub release](https://github.com/ipfs/kubo/releases/tag/vX.Y.Z(-RCN))
143
-- [ ] Notify the bifrost team about the release using `kuboreleaser release --version vX.Y.Z(-RCN) notify-bifrost --date YYYY-MM-DD`
150
+ </details>
151
+- [ ] Notify the bifrost team about the release <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) notify-bifrost --date YYYY-MM-DD` or ...</summary>
152
- [ ] create an issue comment on the issue in the [bifrost-infra](https://github/com/protocol/bifrost-infra)
145
-- [ ] Promote the release using `kuboreleaser release --version vX.Y.Z(-RCN) promote`
153
+ </details>
154
+- [ ] Promote the release <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) promote` or ...</summary>
155
- [ ] create an [IPFS Discourse](https://discuss.ipfs.tech) topic
156
- [prerelease example](https://discuss.ipfs.tech/t/kubo-v0-16-0-rc1-release-candidate-is-out/15248)
157
- [release example](https://discuss.ipfs.tech/t/kubo-v0-16-0-release-is-out/15249)
@@ -164,35 +173,43 @@ This section covers tasks to be done during each release.
173
- [example](https://filecoinproject.slack.com/archives/C018EJ8LWH1/p1664885305374900)
174
- [ ]  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)
175
- [example](https://www.reddit.com/r/ipfs/comments/9x0q0k/kubo_v0160_release_is_out/)
176
+ </details>
177
- [ ]  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
178
- [example](https://github.com/ipfs/kubo/releases/tag/v0.17.0)
169
-- [ ] Test the new version with `ipfs-companion` using `kuboreleaser release --version vX.Y.Z(-RCN) test-ipfs-companion`
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
182
- [ ] wait for the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml) workflow run to finish
173
-- [ ]  Update Kubo in [interop](https://github.com/ipfs/interop) using `kuboreleaser release --version vX.Y.Z(-RCN) update-interop`
183
+ </details>
184
+- [ ]  Update Kubo in [interop](https://github.com/ipfs/interop) <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) update-interop` or ...</summary>
185
- [ ]  check out [ipfs/interop](https://github.com/ipfs/interop)
186
- [ ]  run `npm install`
187
- [ ]  create a PR which updates `package.json` and `package-lock.json`
188
- [ ]  merge the PR
178
-- [ ] Update Kubo in [ipfs-desktop](https://github.com/ipfs/ipfs-desktop) using `kuboreleaser release --version vX.Y.Z(-RCN) update-ipfs-desktop`
189
+ </details>
190
+- [ ] Update Kubo in [ipfs-desktop](https://github.com/ipfs/ipfs-desktop) <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) update-ipfs-desktop` or ...</summary>
191
- [ ] check out [ipfs/ipfs-desktop](https://github.com/ipfs/ipfs-desktop)
192
- [ ] run `npm install`
193
- [ ] create a PR which updates `package.json` and `package-lock.json`
194
- [ ]  merge the PR
183
-- [ ]  Update Kubo docs using `kuboreleaser release --version vX.Y.Z(-RCN) update-ipfs-docs`
195
+ </details>
196
+- [ ]  Update Kubo docs <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) update-ipfs-docs` or ...</summary>
197
- [ ]  run the [update-on-new-ipfs-tag.yml](https://github.com/ipfs/ipfs-docs/actions/workflows/update-on-new-ipfs-tag.yml) workflow
198
- [ ]  merge the PR created by the [update-on-new-ipfs-tag.yml](https://github.com/ipfs/ipfs-docs/actions/workflows/update-on-new-ipfs-tag.yml) workflow run
186
-- [ ]  Create a blog entry on [ipfs.tech](https://blog.ipfs.tech) `kuboreleaser release --version vX.Y.Z(-RCN) update-ipfs-blog --date YYYY-MM-DD`
199
+ </details>
200
+- [ ]  Create a blog entry on [ipfs.tech](https://blog.ipfs.tech) <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) update-ipfs-blog --date YYYY-MM-DD` or ...</summary>
201
- [ ]  create a PR which adds a release note for the new Kubo version
202
- [example](https://github.com/ipfs/ipfs-blog/pull/529)
203
- [ ]  merge the PR
204
- [ ]  verify the blog entry was published
205
+ </details>
206
- [ ] Keep checking the [metrics](https://protocollabs.grafana.net/d/8zlhkKTZk/gateway-slis-precomputed?orgId=1) until the release issue is closed
207
- [release notes](https://www.notion.so/pl-strflt/Kubo-Gateway-Release-Notes-6e0efff28ee540be9ccb8f2b85104c42)
208
- post in the [#bifrost](https://filecoinproject.slack.com/archives/C018EJ8LWH1) channel in FIL Slack if there is a problem
194
-- [ ]  Merge the [release](https://github.com/ipfs/kubo/tree/release) back into [master](https://github.com/ipfs/kubo/tree/master) using `kuboreleaser release --version vX.Y.Z(-RCN) merge-branch`
195
- - ignore the changes to [version.go](version.go) (keep the `-dev` version)
209
+- [ ]  Merge the [release](https://github.com/ipfs/kubo/tree/release) branch back into [master](https://github.com/ipfs/kubo/tree/master), ignoring the changes to [version.go](version.go) (keep the `-dev`) version, <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) merge-branch` or ...</summary>
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>
213
- [ ]   Create the next [changelog](https://github.com/ipfs/kubo/blob/master/docs/changelogs/vX.(Y+1).md)
214
- link to the new changelog in the [CHANGELOG.md](CHANGELOG.md) file
215
- [ ]   Create the next release issue