Skip to content

Commit d62cc49

Browse files
authored
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
1 parent 4ae097e commit d62cc49

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/RELEASE_CHECKLIST.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,10 @@ This section covers tasks to be done during each release.
6969
- do **NOT** use `Squash and merge` nor `Rebase and merge` because we need to be able to sign the merge commit
7070
- do **NOT** delete the `release-vX.Y` branch
7171
</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
7472
- [ ] Create the release tag <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) tag` or ...</summary>
7573
- This is a dangerous operation! Go and Docker publishing are difficult to reverse! Have the release reviewer verify all the commands marked with ⚠️!
7674
- [ ] ⚠️ ![](https://img.shields.io/badge/only-RC-blue?style=flat-square) tag the HEAD commit using `git tag -s vX.Y.Z(-RCN) -m 'Prerelease X.Y.Z(-RCN)'`
77-
- [ ] ⚠️ ![](https://img.shields.io/badge/only-FINAL-green?style=flat-square) tag the HEAD commit of the `release` branch using `git tag -s vX.Y.Z(-RCN) -m 'Release X.Y.Z(-RCN)'`
75+
- [ ] ⚠️ ![](https://img.shields.io/badge/only-FINAL-green?style=flat-square) tag the HEAD commit of the `release` branch using `git tag -s vX.Y.Z -m 'Release X.Y.Z'`
7876
- [ ] ⚠️ verify the tag is signed and tied to the correct commit using `git show vX.Y.Z(-RCN)`
7977
- [ ] ⚠️ push the tag to GitHub using `git push origin vX.Y.Z(-RCN)`
8078
- 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.
111109
- [ ] wait for the [sync-release-assets](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) workflow run to finish
112110
- [ ] verify the release assets are present in the [GitHub release](https://github.com/ipfs/kubo/releases/tag/vX.Y.Z(-RCN))
113111
</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
114114
- [ ] Promote the release <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) promote` or ...</summary>
115115
- [ ] create an [IPFS Discourse](https://discuss.ipfs.tech) topic
116116
- [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.
136136
- [ ] ![](https://img.shields.io/badge/only-FINAL-green?style=flat-square) ![](https://img.shields.io/badge/not-PATCH-yellow?style=flat-square) 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)
137137
- [example](https://www.reddit.com/r/ipfs/comments/9x0q0k/kubo_v0160_release_is_out/)
138138
</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>
140140
- [ ] run the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml)
141141
- use `vX.Y.Z(-RCN)` as the Kubo image version
142142
- [ ] wait for the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml) workflow run to finish

0 commit comments

Comments
 (0)