docs: update release checklist (#10401)
- change thunderdome to after the dockers and binaries are released - simplify the tag command for final releases - add link to IPFS Companion issue about E2E tests
Henrique Dias committed
Apr 15, 2024 at 11:12 UTC
d62cc49a0f7bad2d205314715b1c41679edacc3e
1 file changed
+4
-4
docs/RELEASE_CHECKLIST.md
+4
-4
@@ -69,12 +69,10 @@ This section covers tasks to be done during each release.
69
- do **NOT** use `Squash and merge` nor `Rebase and merge` because we need to be able to sign the merge commit
70
- do **NOT** delete the `release-vX.Y` branch
71
</details>
72
-- [ ] Run Thunderdome testing, see the [Thunderdome release docs](./releases_thunderdome.md) for details
73
- - [ ] create a PR and merge the experiment config into Thunderdome
72
- [ ] Create the release tag <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) tag` or ...</summary>
73
- This is a dangerous operation! Go and Docker publishing are difficult to reverse! Have the release reviewer verify all the commands marked with ⚠️!
74
- [ ] ⚠️  tag the HEAD commit using `git tag -s vX.Y.Z(-RCN) -m 'Prerelease X.Y.Z(-RCN)'`
77
- - [ ] ⚠️  tag the HEAD commit of the `release` branch using `git tag -s vX.Y.Z(-RCN) -m 'Release X.Y.Z(-RCN)'`
75
+ - [ ] ⚠️  tag the HEAD commit of the `release` branch using `git tag -s vX.Y.Z -m 'Release X.Y.Z'`
76
- [ ] ⚠️ verify the tag is signed and tied to the correct commit using `git show vX.Y.Z(-RCN)`
77
- [ ] ⚠️ push the tag to GitHub using `git push origin vX.Y.Z(-RCN)`
78
- do **NOT** use `git push --tags` because it pushes all your local tags
@@ -111,6 +109,8 @@ This section covers tasks to be done during each release.
109
- [ ] wait for the [sync-release-assets](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) workflow run to finish
110
- [ ] verify the release assets are present in the [GitHub release](https://github.com/ipfs/kubo/releases/tag/vX.Y.Z(-RCN))
111
</details>
112
+- [ ] Run Thunderdome testing, see the [Thunderdome release docs](./releases_thunderdome.md) for details
113
+ - [ ] create a PR and merge the experiment config into Thunderdome
114
- [ ] Promote the release <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) promote` or ...</summary>
115
- [ ] create an [IPFS Discourse](https://discuss.ipfs.tech) topic
116
- [prerelease example](https://discuss.ipfs.tech/t/kubo-v0-16-0-rc1-release-candidate-is-out/15248)
@@ -136,7 +136,7 @@ This section covers tasks to be done during each release.
136
- [ ]   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)
137
- [example](https://www.reddit.com/r/ipfs/comments/9x0q0k/kubo_v0160_release_is_out/)
138
</details>
139
-- [ ] Test the new version with `ipfs-companion` <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) test-ipfs-companion` or ...</summary>
139
+- [ ] ~~Test the new version with `ipfs-companion`~~ ([currently skipped](https://github.com/ipfs/ipfs-companion/issues/1300)) <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) test-ipfs-companion` or ...</summary>
140
- [ ] run the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml)
141
- use `vX.Y.Z(-RCN)` as the Kubo image version
142
- [ ] wait for the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml) workflow run to finish