docs: update refs to kuboreleaser in RELEASE_ISSUE_TEMPLATE.md
Piotr Galar committed
Jun 30, 2023 at 15:35 UTC
0d5a9337624d1fda213b8410f75ead4f5eaea5a3
1 file changed
+14
-14
docs/RELEASE_ISSUE_TEMPLATE.md
+14
-14
@@ -84,7 +84,7 @@ This section covers tasks to be done ahead of the release.
84
85
This section covers tasks to be done during each release.
86
87
-- [ ] Prepare the release branch and update version numbers accordingly <details><summary>using `kuboreleaser release --version vX.Y.Z(-rcN) prepare-branch` or ...</summary>
87
+- [ ] Prepare the release branch and update version numbers accordingly <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) prepare-branch` or ...</summary>
88
- [ ] create a new branch `release-vX.Y.Z`
89
- use `master` as base if `Z == 0`
90
- use `release` as base if `Z > 0`
@@ -105,7 +105,7 @@ This section covers tasks to be done during each release.
105
</details>
106
- [ ] Run Thunderdome testing, see the [Thunderdome release docs](./releases_thunderdome.md) for details
107
- [ ] create a PR and merge the experiment config into Thunderdome
108
-- [ ] Create the release tag <details><summary>using `kuboreleaser release --version vX.Y.Z(-rcN) tag` or ...</summary>
108
+- [ ] Create the release tag <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) tag` or ...</summary>
109
- This is a dangerous operation! Go and Docker publishing are difficult to reverse! Have the release reviewer verify all the commands marked with ⚠️!
110
- [ ] ⚠️  tag the HEAD commit using `git tag -s vX.Y.Z(-RCN) -m 'Prerelease X.Y.Z(-RCN)'`
111
- [ ] ⚠️  tag the HEAD commit of the `release` branch using `git tag -s vX.Y.Z(-RCN) -m 'Release X.Y.Z(-RCN)'`
@@ -113,10 +113,10 @@ This section covers tasks to be done during each release.
113
- [ ] ⚠️ push the tag to GitHub using `git push origin vX.Y.Z(-RCN)`
114
- do **NOT** use `git push --tags` because it pushes all your local tags
115
</details>
116
-- [ ] 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>
116
+- [ ] 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>
117
- [ ] Wait for [Publish docker image](https://github.com/ipfs/kubo/actions/workflows/docker-image.yml) workflow run initiated by the tag push to finish
118
- [ ] verify the image is available on [Docker Hub](https://hub.docker.com/r/ipfs/kubo/tags)
119
-- [ ] 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>
119
+- [ ] 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>
120
- [ ] check out [ipfs/distributions](https://github.com/ipfs/distributions)
121
- [ ] run `./dist.sh add-version kubo vX.Y.Z(-RCN)` to add the new version to the `versions` file
122
- [usage](https://github.com/ipfs/distributions#usage)
@@ -125,12 +125,12 @@ This section covers tasks to be done during each release.
125
- [ ] wait for the [CI](https://github.com/ipfs/distributions/actions/workflows/main.yml) workflow run initiated by the merge to master to finish
126
- [ ] verify the release is available on [dist.ipfs.io](https://dist.ipfs.io/#kubo)
127
</details>
128
-- [ ] 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>
128
+- [ ] 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>
129
- [ ] run the [Release to npm](https://github.com/ipfs/npm-go-ipfs/actions/workflows/main.yml) workflow
130
- [ ] 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
131
- [ ] verify the release is available on [NPM](https://www.npmjs.com/package/go-ipfs?activeTab=versions)
132
</details>
133
-- [ ] 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>
133
+- [ ] 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>
134
- [ ] create a new release on [GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release)
135
- [RC example](https://github.com/ipfs/kubo/releases/tag/v0.17.0-rc1)
136
- [FINAL example](https://github.com/ipfs/kubo/releases/tag/v0.17.0)
@@ -144,7 +144,7 @@ This section covers tasks to be done during each release.
144
- [ ] wait for the [sync-release-assets](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) workflow run to finish
145
- [ ] verify the release assets are present in the [GitHub release](https://github.com/ipfs/kubo/releases/tag/vX.Y.Z(-RCN))
146
</details>
147
-- [ ] Promote the release <details><summary>using `kuboreleaser release --version vX.Y.Z(-rcN) promote` or ...</summary>
147
+- [ ] Promote the release <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) promote` or ...</summary>
148
- [ ] create an [IPFS Discourse](https://discuss.ipfs.tech) topic
149
- [prerelease example](https://discuss.ipfs.tech/t/kubo-v0-16-0-rc1-release-candidate-is-out/15248)
150
- [release example](https://discuss.ipfs.tech/t/kubo-v0-16-0-release-is-out/15249)
@@ -169,38 +169,38 @@ This section covers tasks to be done during each release.
169
- [ ]   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)
170
- [example](https://www.reddit.com/r/ipfs/comments/9x0q0k/kubo_v0160_release_is_out/)
171
</details>
172
-- [ ] Test the new version with `ipfs-companion` <details><summary>using `kuboreleaser release --version vX.Y.Z(-rcN) test-ipfs-companion` or ...</summary>
172
+- [ ] Test the new version with `ipfs-companion` <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) test-ipfs-companion` or ...</summary>
173
- [ ] run the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml)
174
- use `vX.Y.Z(-RCN)` as the Kubo image version
175
- [ ] wait for the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml) workflow run to finish
176
</details>
177
-- [ ]  Update Kubo in [interop](https://github.com/ipfs/interop) <details><summary>using `kuboreleaser release --version vX.Y.Z(-rcN) update-interop` or ...</summary>
177
+- [ ]  Update Kubo in [interop](https://github.com/ipfs/interop) <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) update-interop` or ...</summary>
178
- [ ]  check out [ipfs/interop](https://github.com/ipfs/interop)
179
- [ ]  run `npm install`
180
- [ ]  create a PR which updates `package.json` and `package-lock.json`
181
- [ ]  merge the PR
182
</details>
183
-- [ ]  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>
183
+- [ ]  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>
184
- [ ] check out [ipfs/ipfs-desktop](https://github.com/ipfs/ipfs-desktop)
185
- [ ] run `npm install`
186
- [ ] create a PR which updates `package.json` and `package-lock.json`
187
- [ ]  add @SgtPooki and @whizzzkid as reviewers
188
</details>
189
-- [ ]  Update Kubo docs <details><summary>using `kuboreleaser release --version vX.Y.Z(-rcN) update-ipfs-docs` or ...</summary>
189
+- [ ]  Update Kubo docs <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) update-ipfs-docs` or ...</summary>
190
- [ ]  run the [update-on-new-ipfs-tag.yml](https://github.com/ipfs/ipfs-docs/actions/workflows/update-on-new-ipfs-tag.yml) workflow
191
- [ ]  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
192
</details>
193
-- [ ]  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>
193
+- [ ]  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>
194
- [ ]  create a PR which adds a release note for the new Kubo version
195
- [example](https://github.com/ipfs/ipfs-blog/pull/529)
196
- [ ]  merge the PR
197
- [ ]  verify the blog entry was published
198
</details>
199
-- [ ]  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>
199
+- [ ]  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>
200
- [ ] create a new branch `merge-release-vX.Y.Z` from `release`
201
- [ ] create and merge a PR from `merge-release-vX.Y.Z` to `master`
202
</details>
203
-- [ ]   Prepare for the next release <details><summary>using `kuboreleaser release --version vX.Y.Z(-rcN) prepare-next` or ...</summary>
203
+- [ ]   Prepare for the next release <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) prepare-next` or ...</summary>
204
- [ ]   Create the next [changelog](https://github.com/ipfs/kubo/blob/master/docs/changelogs/vX.(Y+1).md)
205
- [ ]   Link to the new changelog in the [CHANGELOG.md](CHANGELOG.md) file
206
- [ ]   Create the next release issue