docs: update RELEASE_CHECKLIST.md (#10564)
Based on 0.32 iteration
Marcin Rataj committed
Nov 14, 2024 at 04:04 UTC
720663d7c8f9971d34f85bd4c02a256da2d56a25
1 file changed
+12
-12
docs/RELEASE_CHECKLIST.md
+12
-12
@@ -1,4 +1,4 @@
1
-<!-- Last updated during [v0.30.0 release](https://github.com/ipfs/kubo/pull/10496) -->
1
+<!-- Last updated during [v0.32.0 release](https://github.com/ipfs/kubo/issues/10547) -->
2
3
# ✅ Release Checklist (vX.Y.Z[-rcN])
4
@@ -56,7 +56,7 @@ This section covers tasks to be done during each release.
56
- use `release` as base if `Z > 0`
57
- [ ]  update the `CurrentVersionNumber` in [version.go](version.go) in the `master` branch to `vX.Y+1.0-dev`
58
- [example](https://github.com/ipfs/kubo/pull/9305)
59
- - [ ] update the `CurrentVersionNumber` in [version.go](version.go) in the `release-vX.Y` branch to `vX.Y.Z(-RCN)`
59
+ - [ ] update the `CurrentVersionNumber` in [version.go](version.go) in the `release-vX.Y` branch to `vX.Y.Z(-rcN)`
60
- [example](https://github.com/ipfs/kubo/pull/9394)
61
- [ ] create a draft PR from `release-vX.Y` to `release`
62
- [example](https://github.com/ipfs/kubo/pull/9306)
@@ -71,10 +71,10 @@ This section covers tasks to be done during each release.
71
</details>
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)'`
74
+ - [ ] ⚠️  tag the HEAD commit using `git tag -s vX.Y.Z(-rcN) -m 'Prerelease 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)`
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
79
</details>
80
- [ ] Verify [ipfs/distributions](https://github.com/ipfs/distributions)'s `.tool-versions`'s `golang` entry is set to the [latest go release](https://go.dev/doc/devel/release) on the major go branch [Kubo is being tested on](https://github.com/ipfs/kubo/blob/master/.github/workflows/gotest.yml) (see `go-version:`).
@@ -85,7 +85,7 @@ This section covers tasks to be done during each release.
85
- [ ] Publish the release to [dist.ipfs.tech](https://dist.ipfs.tech) <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) publish-to-distributions` or ...</summary>
86
- [ ] check out [ipfs/distributions](https://github.com/ipfs/distributions)
87
- [ ] create new branch: run `git checkout -b release-kubo-X.Y.Z(-rcN)`
88
- - [ ] run `./dist.sh add-version kubo vX.Y.Z(-RCN)` to add the new version to the `versions` file
88
+ - [ ] run `./dist.sh add-version kubo vX.Y.Z(-rcN)` to add the new version to the `versions` file
89
- [usage](https://github.com/ipfs/distributions#usage)
90
- [ ] create and merge the PR which updates `dists/kubo/versions` and `dists/go-ipfs/versions` ( and `dists/kubo/current` and `dists/go-ipfs/current`)
91
- [example](https://github.com/ipfs/distributions/pull/760)
@@ -101,7 +101,7 @@ This section covers tasks to be done during each release.
101
- [ ] create a new release on [GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release)
102
- [RC example](https://github.com/ipfs/kubo/releases/tag/v0.17.0-rc1)
103
- [FINAL example](https://github.com/ipfs/kubo/releases/tag/v0.17.0)
104
- - [ ] use the `vX.Y.Z(-RCN)` tag
104
+ - [ ] use the `vX.Y.Z(-rcN)` tag
105
- [ ] link to the release issue
106
- [ ]  link to the changelog in the description
107
- [ ]  check the `This is a pre-release` checkbox
@@ -109,7 +109,7 @@ This section covers tasks to be done during each release.
109
- [ ]  do **NOT** check the `This is a pre-release` checkbox
110
- [ ] run the [sync-release-assets](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) workflow
111
- [ ] wait for the [sync-release-assets](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) workflow run to finish
112
- - [ ] verify the release assets are present in the [GitHub release](https://github.com/ipfs/kubo/releases/tag/vX.Y.Z(-RCN))
112
+ - [ ] verify the release assets are present in the [GitHub release](https://github.com/ipfs/kubo/releases/tag/vX.Y.Z(-rcN))
113
</details>
114
- [ ] Update Kubo staging environment, see the [Running Kubo tests on staging](https://www.notion.so/Running-Kubo-tests-on-staging-488578bb46154f9bad982e4205621af8) for details.
115
- [ ]  Test last release against the current RC
@@ -118,7 +118,7 @@ This section covers tasks to be done during each release.
118
- [ ] create an [IPFS Discourse](https://discuss.ipfs.tech) topic
119
- [prerelease example](https://discuss.ipfs.tech/t/kubo-v0-16-0-rc1-release-candidate-is-out/15248)
120
- [release example](https://discuss.ipfs.tech/t/kubo-v0-16-0-release-is-out/15249)
121
- - [ ] use `Kubo vX.Y.Z(-RCN) is out!` as the title
121
+ - [ ] use `Kubo vX.Y.Z(-rcN) is out!` as the title
122
- [ ] use `kubo` and `go-ipfs` as topics
123
- [ ] repeat the title as a heading (`##`) in the description
124
- [ ] link to the GitHub Release, binaries on IPNS, docker pull command and release notes in the description
@@ -128,7 +128,7 @@ This section covers tasks to be done during each release.
128
- [ ] [#ipfs-chatter](https://discord.com/channels/669268347736686612/669268347736686615) in IPFS Discord
129
- [ ] [#ipfs-chatter](https://filecoinproject.slack.com/archives/C018EJ8LWH1) in FIL Slack
130
- [ ] [#ipfs-chatter:ipfs.io](https://matrix.to/#/#ipfs-chatter:ipfs.io) in Matrix
131
- - [ ]  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
131
+ - [ ]  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
132
- [example](https://github.com/ipfs/kubo/releases/tag/v0.17.0)
133
- [ ]  create an issue comment mentioning early testers on the release issue
134
- [example](https://github.com/ipfs/kubo/issues/9319#issuecomment-1311002478)
@@ -136,12 +136,12 @@ This section covers tasks to be done during each release.
136
- [example](https://github.com/ipfs/kubo/issues/9417#issuecomment-1400740975)
137
- [ ]   ask the marketing team to tweet about the release in [#shared-pl-marketing-requests](https://filecoinproject.slack.com/archives/C018EJ8LWH1) in FIL Slack
138
- [example](https://filecoinproject.slack.com/archives/C018EJ8LWH1/p1664885305374900)
139
- - [ ]   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)
139
+ - [ ]   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)
140
- [example](https://www.reddit.com/r/ipfs/comments/9x0q0k/kubo_v0160_release_is_out/)
141
</details>
142
- [ ] ~~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>
143
- [ ] run the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml)
144
- - use `vX.Y.Z(-RCN)` as the Kubo image version
144
+ - use `vX.Y.Z(-rcN)` as the Kubo image version
145
- [ ] wait for the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml) workflow run to finish
146
</details>
147
- [ ]  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>