chore: update release issue template to use lowercase for rc
galargh committed
Mar 6, 2023 at 20:25 UTC
a52625f1812145c439d92eb5890cb295d8121ace
1 file changed
+16
-16
docs/RELEASE_ISSUE_TEMPLATE.md
+16
-16
@@ -79,7 +79,7 @@ This section covers tasks to be done ahead of the release.
79
- [example](https://github.com/ipfs/distributions/pull/756)
80
- [ ]  [ipfs/ipfs-docs](https://github.com/ipfs/ipfs-docs)
81
- [example](https://github.com/ipfs/ipfs-docs/pull/1298)
82
-- [ ] 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>
82
+- [ ] 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>
83
- [ ] open an issue against [bifrost-infra](https://github.com/protocol/bifrost-infra)
84
- [example](https://github.com/protocol/bifrost-infra/issues/2221)
85
</details>
@@ -93,7 +93,7 @@ This section covers tasks to be done ahead of the release.
93
94
This section covers tasks to be done during each release.
95
96
-- [ ] Prepare the release branch and update version numbers accordingly <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) prepare-branch` or ...</summary>
96
+- [ ] Prepare the release branch and update version numbers accordingly <details><summary>using `kuboreleaser release --version vX.Y.Z(-rcN) prepare-branch` or ...</summary>
97
- [ ] create a new branch `release-vX.Y.Z`
98
- use `master` as base if `Z == 0`
99
- use `release` as base if `Z > 0`
@@ -112,7 +112,7 @@ This section covers tasks to be done during each release.
112
- do **NOT** use `Squash and merge` nor `Rebase and merge` because we need to be able to sign the merge commit
113
- do **NOT** delete the `release-vX.Y` branch
114
</details>
115
-- [ ] Create the release tag <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) tag` or ...</summary>
115
+- [ ] Create the release tag <details><summary>using `kuboreleaser release --version vX.Y.Z(-rcN) tag` or ...</summary>
116
- This is a dangerous operation! Go and Docker publishing are difficult to reverse! Have the release reviewer verify all the commands marked with ⚠️!
117
- [ ] ⚠️  tag the HEAD commit using `git tag -s vX.Y.Z(-RCN) -m 'Prerelease X.Y.Z(-RCN)'`
118
- [ ] ⚠️  tag the HEAD commit of the `release` branch using `git tag -s vX.Y.Z(-RCN) -m 'Release X.Y.Z(-RCN)'`
@@ -120,10 +120,10 @@ This section covers tasks to be done during each release.
120
- [ ] ⚠️ push the tag to GitHub using `git push origin vX.Y.Z(-RCN)`
121
- do **NOT** use `git push --tags` because it pushes all your local tags
122
</details>
123
-- [ ] 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>
123
+- [ ] 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>
124
- [ ] Wait for [Publish docker image](https://github.com/ipfs/kubo/actions/workflows/docker-image.yml) workflow run initiated by the tag push to finish
125
- [ ] verify the image is available on [Docker Hub](https://hub.docker.com/r/ipfs/kubo/tags)
126
-- [ ] 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>
126
+- [ ] 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>
127
- [ ] check out [ipfs/distributions](https://github.com/ipfs/distributions)
128
- [ ] run `./dist.sh add-version kubo vX.Y.Z(-RCN)` to add the new version to the `versions` file
129
- [usage](https://github.com/ipfs/distributions#usage)
@@ -132,12 +132,12 @@ This section covers tasks to be done during each release.
132
- [ ] wait for the [CI](https://github.com/ipfs/distributions/actions/workflows/main.yml) workflow run initiated by the merge to master to finish
133
- [ ] verify the release is available on [dist.ipfs.io](https://dist.ipfs.io/#kubo)
134
</details>
135
-- [ ] 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>
135
+- [ ] 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>
136
- [ ] run the [Release to npm](https://github.com/ipfs/npm-go-ipfs/actions/workflows/main.yml) workflow
137
- [ ] 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
138
- [ ] verify the release is available on [NPM](https://www.npmjs.com/package/go-ipfs?activeTab=versions)
139
</details>
140
-- [ ] 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>
140
+- [ ] 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>
141
- [ ] create a new release on [GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release)
142
- [RC example](https://github.com/ipfs/kubo/releases/tag/v0.17.0-rc1)
143
- [FINAL example](https://github.com/ipfs/kubo/releases/tag/v0.17.0)
@@ -151,10 +151,10 @@ This section covers tasks to be done during each release.
151
- [ ] wait for the [sync-release-assets](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) workflow run to finish
152
- [ ] verify the release assets are present in the [GitHub release](https://github.com/ipfs/kubo/releases/tag/vX.Y.Z(-RCN))
153
</details>
154
-- [ ] 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>
154
+- [ ] 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>
155
- [ ] create an issue comment on the issue in the [bifrost-infra](https://github/com/protocol/bifrost-infra)
156
</details>
157
-- [ ] Promote the release <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) promote` or ...</summary>
157
+- [ ] Promote the release <details><summary>using `kuboreleaser release --version vX.Y.Z(-rcN) promote` or ...</summary>
158
- [ ] create an [IPFS Discourse](https://discuss.ipfs.tech) topic
159
- [prerelease example](https://discuss.ipfs.tech/t/kubo-v0-16-0-rc1-release-candidate-is-out/15248)
160
- [release example](https://discuss.ipfs.tech/t/kubo-v0-16-0-release-is-out/15249)
@@ -179,28 +179,28 @@ This section covers tasks to be done during each release.
179
- [ ]   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)
180
- [example](https://www.reddit.com/r/ipfs/comments/9x0q0k/kubo_v0160_release_is_out/)
181
</details>
182
-- [ ] Test the new version with `ipfs-companion` <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) test-ipfs-companion` or ...</summary>
182
+- [ ] Test the new version with `ipfs-companion` <details><summary>using `kuboreleaser release --version vX.Y.Z(-rcN) test-ipfs-companion` or ...</summary>
183
- [ ] run the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml)
184
- use `vX.Y.Z(-RCN)` as the Kubo image version
185
- [ ] wait for the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml) workflow run to finish
186
</details>
187
-- [ ]  Update Kubo in [interop](https://github.com/ipfs/interop) <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) update-interop` or ...</summary>
187
+- [ ]  Update Kubo in [interop](https://github.com/ipfs/interop) <details><summary>using `kuboreleaser release --version vX.Y.Z(-rcN) update-interop` or ...</summary>
188
- [ ]  check out [ipfs/interop](https://github.com/ipfs/interop)
189
- [ ]  run `npm install`
190
- [ ]  create a PR which updates `package.json` and `package-lock.json`
191
- [ ]  merge the PR
192
</details>
193
-- [ ] 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>
193
+- [ ] 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>
194
- [ ] check out [ipfs/ipfs-desktop](https://github.com/ipfs/ipfs-desktop)
195
- [ ] run `npm install`
196
- [ ] create a PR which updates `package.json` and `package-lock.json`
197
- [ ]  add @SgtPooki and @whizzzkid as reviewers
198
</details>
199
-- [ ]  Update Kubo docs <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) update-ipfs-docs` or ...</summary>
199
+- [ ]  Update Kubo docs <details><summary>using `kuboreleaser release --version vX.Y.Z(-rcN) update-ipfs-docs` or ...</summary>
200
- [ ]  run the [update-on-new-ipfs-tag.yml](https://github.com/ipfs/ipfs-docs/actions/workflows/update-on-new-ipfs-tag.yml) workflow
201
- [ ]  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
202
</details>
203
-- [ ]  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>
203
+- [ ]  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>
204
- [ ]  create a PR which adds a release note for the new Kubo version
205
- [example](https://github.com/ipfs/ipfs-blog/pull/529)
206
- [ ]  merge the PR
@@ -209,11 +209,11 @@ This section covers tasks to be done during each release.
209
- [ ]  Keep checking the [metrics](https://protocollabs.grafana.net/d/8zlhkKTZk/gateway-slis-precomputed?orgId=1) until the release issue is closed
210
- [release notes](https://www.notion.so/pl-strflt/Kubo-Gateway-Release-Notes-6e0efff28ee540be9ccb8f2b85104c42)
211
- post in the [#bifrost](https://filecoinproject.slack.com/archives/C018EJ8LWH1) channel in FIL Slack if there is a problem
212
-- [ ]  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>
212
+- [ ]  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>
213
- [ ] create a new branch `merge-release-vX.Y.Z` from `release`
214
- [ ] create and merge a PR from `merge-release-vX.Y.Z` to `master`
215
</details>
216
-- [ ]   Prepare for the next release <details><summary>using `kuboreleaser release --version vX.Y.Z(-RCN) prepare-next` or ...</summary>
216
+- [ ]   Prepare for the next release <details><summary>using `kuboreleaser release --version vX.Y.Z(-rcN) prepare-next` or ...</summary>
217
- [ ]   Create the next [changelog](https://github.com/ipfs/kubo/blob/master/docs/changelogs/vX.(Y+1).md)
218
- [ ]   Link to the new changelog in the [CHANGELOG.md](CHANGELOG.md) file
219
- [ ]   Create the next release issue