docs: improve release issue template (#10305)
Henrique Dias committed
Jan 16, 2024 at 14:33 UTC
e11d7b0c13a007351ee9cc4108f2860eea15f404
2 files changed
+197
-204
docs/RELEASE_CHECKLIST.md
new
+180
@@ -0,0 +1,180 @@
1
+<!-- Last updated during [v0.26.0 release](https://github.com/ipfs/kubo/issues/10259) -->
2
+
3
+# ✅ Release Checklist (vX.Y.Z[-rcN])
4
+
5
+## Labels
6
+
7
+If an item should be executed for a specific release type, it should be labeled with one of the following labels:
8
+
9
+-  execute **ONLY** when releasing a Release Candidate
10
+-  execute **ONLY** when releasing a Final Release
11
+
12
+Otherwise, it means it should be executed for **ALL** release types.
13
+
14
+Patch releases should follow the same process as `.0` releases. If some item should **NOT** be executed for a Patch Release, it should be labeled with:
15
+
16
+-  do **NOT** execute when releasing a Patch Release
17
+
18
+## Before the release
19
+
20
+This section covers tasks to be done ahead of the release.
21
+
22
+- [ ] Verify you have access to all the services and tools required for the release
23
+ - [ ] [GPG signature](https://docs.github.com/en/authentication/managing-commit-signature-verification) configured in local git and in GitHub
24
+ - [ ] [admin access to IPFS Discourse](https://discuss.ipfs.tech/g/admins)
25
+ - ask the previous release owner (or @2color) for an invite
26
+ - [ ]  [access to #shared-pl-marketing-requests](https://filecoinproject.slack.com/archives/C018EJ8LWH1) channel in FIL Slack
27
+ - ask the previous release owner for an invite
28
+ - [ ] [access to IPFS network metrics](https://github.com/protocol/pldw/blob/624f47cf4ec14ad2cec6adf601a9f7b203ef770d/docs/sources/ipfs.md#ipfs-network-metrics) dashboards in Grafana
29
+ - open an access request in the [pldw](https://github.com/protocol/pldw/issues/new/choose)
30
+ - [example](https://github.com/protocol/pldw/issues/158)
31
+ - [ ] [kuboreleaser](https://github.com/ipfs/kuboreleaser) checked out on your system (_only if you're using [kuboreleaser](https://github.com/ipfs/kuboreleaser)_)
32
+ - [ ] [Thunderdome](https://github.com/ipfs-shipyard/thunderdome) checked out on your system and configured (see the [Thunderdome release docs](./releases_thunderdome.md) for setup)
33
+ - [ ] [docker](https://docs.docker.com/get-docker/) installed on your system (_only if you're using [kuboreleaser](https://github.com/ipfs/kuboreleaser)_)
34
+ - [ ] [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed on your system (_only if you're **NOT** using [kuboreleaser](https://github.com/ipfs/kuboreleaser)_)
35
+ - [ ] [zsh](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH#install-and-set-up-zsh-as-default) installed on your system
36
+ - [ ] [kubo](https://github.com/ipfs/kubo) checked out under `$(go env GOPATH)/src/github.com/ipfs/kubo`
37
+ - you can also symlink your clone to the expected location by running `mkdir -p $(go env GOPATH)/src/github.com/ipfs && ln -s $(pwd) $(go env GOPATH)/src/github.com/ipfs/kubo`
38
+ - [ ]  [Reddit](https://www.reddit.com) account
39
+-  Upgrade Go used in CI to the latest patch release available in [CircleCI](https://hub.docker.com/r/cimg/go/tags) in:
40
+ - [ ]  [ipfs/distributions](https://github.com/ipfs/distributions)
41
+ - [example](https://github.com/ipfs/distributions/pull/756)
42
+ - [ ]  [ipfs/ipfs-docs](https://github.com/ipfs/ipfs-docs)
43
+ - [example](https://github.com/ipfs/ipfs-docs/pull/1298)
44
+- [ ] Verify there is nothing [left for release](-what-s-left-for-release)
45
+- [ ] Create a release process improvement PR
46
+ - [ ] update the [release issue template](docs/RELEASE_ISSUE_TEMPLATE.md) as you go
47
+ - [ ] link it in the [Meta](#meta) section
48
+
49
+## The release
50
+
51
+This section covers tasks to be done during each release.
52
+
53
+- [ ] Prepare the release branch and update version numbers accordingly <details><summary>using `./kuboreleaser --skip-check-before release --version vX.Y.Z(-rcN) prepare-branch` or ...</summary>
54
+ - [ ] create a new branch `release-vX.Y.Z`
55
+ - use `master` as base if `Z == 0`
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)`
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)
63
+ - [ ] Cherry-pick commits from `master` to the `release-vX.Y.Z` using `git cherry-pick -x <commit>`
64
+ - [ ]  Add full changelog and contributors to the [changelog](docs/changelogs/vX.Y.md)
65
+ - [ ]  Replace the `Changelog` and `Contributors` sections of the [changelog](docs/changelogs/vX.Y.md) with the stdout of `./bin/mkreleaselog`
66
+ - do **NOT** copy the stderr
67
+ - [ ] verify all CI checks on the PR from `release-vX.Y` to `release` are passing
68
+ - [ ]  Merge the PR from `release-vX.Y` to `release` using the `Create a merge commit`
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
74
+- [ ] Create the release tag <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) tag` or ...</summary>
75
+ - This is a dangerous operation! Go and Docker publishing are difficult to reverse! Have the release reviewer verify all the commands marked with ⚠️!
76
+ - [ ] ⚠️  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)'`
78
+ - [ ] ⚠️ verify the tag is signed and tied to the correct commit using `git show vX.Y.Z(-RCN)`
79
+ - [ ] ⚠️ push the tag to GitHub using `git push origin vX.Y.Z(-RCN)`
80
+ - do **NOT** use `git push --tags` because it pushes all your local tags
81
+ </details>
82
+- [ ] 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>
83
+ - [ ] Wait for [Publish docker image](https://github.com/ipfs/kubo/actions/workflows/docker-image.yml) workflow run initiated by the tag push to finish
84
+ - [ ] verify the image is available on [Docker Hub](https://hub.docker.com/r/ipfs/kubo/tags)
85
+- [ ] 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:`).
86
+- [ ] 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>
87
+ - [ ] check out [ipfs/distributions](https://github.com/ipfs/distributions)
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_version` and `dists/go-ipfs/current_version`)
91
+ - [example](https://github.com/ipfs/distributions/pull/760)
92
+ - [ ] wait for the [CI](https://github.com/ipfs/distributions/actions/workflows/main.yml) workflow run initiated by the merge to master to finish
93
+ - [ ] verify the release is available on [dist.ipfs.io](https://dist.ipfs.io/#kubo)
94
+ </details>
95
+- [ ] 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` (⚠️ you might need to run the command a couple of times because GHA might not be able to see the new distribution straight away due to caching) or ...</summary>
96
+ - [ ] run the [Release to npm](https://github.com/ipfs/npm-go-ipfs/actions/workflows/main.yml) workflow
97
+ - [ ] 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
98
+ - [ ] verify the release is available on [NPM](https://www.npmjs.com/package/go-ipfs?activeTab=versions)
99
+ </details>
100
+- [ ] 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>
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
105
+ - [ ] link to the release issue
106
+ - [ ]  link to the changelog in the description
107
+ - [ ]  check the `This is a pre-release` checkbox
108
+ - [ ]  copy the changelog (without the header) in the description
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))
113
+ </details>
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)
117
+ - [release example](https://discuss.ipfs.tech/t/kubo-v0-16-0-release-is-out/15249)
118
+ - [ ] use `Kubo vX.Y.Z(-RCN) is out!` as the title
119
+ - [ ] use `kubo` and `go-ipfs` as topics
120
+ - [ ] repeat the title as a heading (`##`) in the description
121
+ - [ ] link to the GitHub Release, binaries on IPNS, docker pull command and release notes in the description
122
+ - [ ] pin the [IPFS Discourse](https://discuss.ipfs.tech) topic globally
123
+ - you can make the topic a banner if there is no banner already
124
+ - verify the [IPFS Discourse](https://discuss.ipfs.tech) topic was copied to:
125
+ - [ ] [#ipfs-chatter](https://discord.com/channels/669268347736686612/669268347736686615) in IPFS Discord
126
+ - [ ] [#ipfs-chatter](https://filecoinproject.slack.com/archives/C018EJ8LWH1) in FIL Slack
127
+ - [ ] [#ipfs-chatter:ipfs.io](https://matrix.to/#/#ipfs-chatter:ipfs.io) in Matrix
128
+ - [ ]  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
129
+ - [example](https://github.com/ipfs/kubo/releases/tag/v0.17.0)
130
+ - [ ]  create an issue comment mentioning early testers on the release issue
131
+ - [example](https://github.com/ipfs/kubo/issues/9319#issuecomment-1311002478)
132
+ - [ ]  create an issue comment linking to the release on the release issue
133
+ - [example](https://github.com/ipfs/kubo/issues/9417#issuecomment-1400740975)
134
+ - [ ]   ask the marketing team to tweet about the release in [#shared-pl-marketing-requests](https://filecoinproject.slack.com/archives/C018EJ8LWH1) in FIL Slack
135
+ - [example](https://filecoinproject.slack.com/archives/C018EJ8LWH1/p1664885305374900)
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>
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
143
+ </details>
144
+- [ ]  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>
145
+ - [ ] check out [ipfs/ipfs-desktop](https://github.com/ipfs/ipfs-desktop)
146
+ - [ ] run `npm install`
147
+ - [ ] create a PR which updates `package.json` and `package-lock.json`
148
+ - [ ]  add @SgtPooki and @whizzzkid as reviewers
149
+ </details>
150
+- [ ]  Update Kubo docs <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) update-ipfs-docs` or ...</summary>
151
+ - [ ]  run the [update-on-new-ipfs-tag.yml](https://github.com/ipfs/ipfs-docs/actions/workflows/update-on-new-ipfs-tag.yml) workflow
152
+ - [ ]  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
153
+ </details>
154
+- [ ]  Ask Brave to update Kubo in Brave Desktop
155
+ - [ ]  use [this link](https://github.com/brave/brave-browser/issues/new?assignees=&labels=OS%2FDesktop&projects=&template=desktop.md&title=) to create an issue for the new Kubo version
156
+ - [basic example](https://github.com/brave/brave-browser/issues/31453), [example with additional notes](https://github.com/brave/brave-browser/issues/27965)
157
+ - [ ]  post link to the issue in `#shared-pl-brave` for visibility
158
+- [ ]  Create a blog entry on [blog.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>
159
+ - [ ]  create a PR which adds a release note for the new Kubo version
160
+ - [example](https://github.com/ipfs/ipfs-blog/pull/529)
161
+ - [ ]  merge the PR
162
+ - [ ]  verify the blog entry was published
163
+ </details>
164
+- [ ]  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>
165
+ - [ ] create a new branch `merge-release-vX.Y.Z` from `release`
166
+ - [ ] create and merge a PR from `merge-release-vX.Y.Z` to `master`
167
+ </details>
168
+- [ ]   Prepare for the next release <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) prepare-next` or ...</summary>
169
+ - [ ]   Create the next [changelog](https://github.com/ipfs/kubo/blob/master/docs/changelogs/vX.(Y+1).md)
170
+ - [ ]   Link to the new changelog in the [CHANGELOG.md](CHANGELOG.md) file
171
+ - [ ]   Create the next release issue
172
+ </details>
173
+- [ ]   Create a dependency update PR
174
+ - [ ]   check out [ipfs/kubo](https://github.com/ipfs/kubo)
175
+ - [ ]   run `go get -u` in root directory
176
+ - [ ]   run `go mod tidy` in root directory
177
+ - [ ]   run `go mod tidy` in `docs/examples/kubo-as-a-library` directory
178
+ - [ ]   create a PR which updates `go.mod` and `go.sum`
179
+ - [ ]   add the PR to the next release milestone
180
+- [ ]  Close the release issue
docs/RELEASE_ISSUE_TEMPLATE.md
+17
-204
@@ -1,222 +1,35 @@
1
-<!-- Last updated during [v0.18.0 release](https://github.com/ipfs/kubo/issues/9417) -->
1
+<!-- Last updated during [v0.26.0 release](https://github.com/ipfs/kubo/issues/10259) -->
2
3
# Items to do upon creating the release issue
4
+
5
- [ ] Fill in the Meta section
6
- [ ] Assign the issue to the release owner and reviewer.
7
- [ ] Name the issue "Release vX.Y.Z"
8
- [ ] Set the proper values for X.Y.Z
9
- [ ] Pin the issue
10
11
+<!--
12
+ For each pre-release and final release, copy the [release checklist](docs/RELEASE_CHECKLIST.md)
13
+ in a new comment and replace the title with the correct value. Having a single comment per
14
+ release candidate and final release provides clarity on what steps have already been run per each
15
+ release.
16
+-->
17
+
18
# Meta
19
+
20
* Release owner: @who
21
* Release reviewer: @who
22
* Expected RC date: week of YYYY-MM-DD
23
* 🚢 Expected final release date: YYYY-MM-DD
15
-* Accompanying PR for improving the release process: (example: https://github.com/ipfs/kubo/pull/9391)
16
-
17
-See the [Kubo release process](https://pl-strflt.notion.site/Kubo-Release-Process-5a5d066264704009a28a79cff93062c4) for more info.
18
-
19
-# Kubo X.Y.Z Release
20
-
21
-We're happy to announce Kubo X.Y.Z!
22
-
23
-As usual, this release includes important fixes, some of which may be critical for security. Unless the fix addresses a bug being exploited in the wild, the fix will _not_ be called out in the release notes. Please make sure to update ASAP. See our [security fix policy](https://github.com/ipfs/go-ipfs/tree/master/docs/releases.md#security-fix-policy) for details.
24
-
25
-## 🗺 What's left for release
26
-
27
-<List of items with PRs and/or Issues to be considered for this release>
28
-
29
-### Required
30
-
31
-### Nice to have
32
-
33
-## 🔦 Highlights
34
-
35
-< top highlights for this release notes. For ANY version (final or RCs) >
36
-
37
-## ✅ Release Checklist
38
-
39
-### Labels
40
-
41
-If an item should be executed for a specific release type, it should be labeled with one of the following labels:
42
-
43
--  execute **ONLY** when releasing a Release Candidate
44
--  execute **ONLY** when releasing a Final Release
45
-
46
-Otherwise, it means it should be executed for **ALL** release types.
47
-
48
-Patch releases should follow the same process as `.0` releases. If some item should **NOT** be executed for a Patch Release, it should be labeled with:
49
-
50
--  do **NOT** execute when releasing a Patch Release
51
-
52
-### Before the release
53
-
54
-This section covers tasks to be done ahead of the release.
55
-
56
-- [ ] Verify you have access to all the services and tools required for the release
57
- - [ ] [GPG signature](https://docs.github.com/en/authentication/managing-commit-signature-verification) configured in local git and in GitHub
58
- - [ ] [admin access to IPFS Discourse](https://discuss.ipfs.tech/g/admins)
59
- - ask the previous release owner (or @2color) for an invite
60
- - [ ]  [access to #shared-pl-marketing-requests](https://filecoinproject.slack.com/archives/C018EJ8LWH1) channel in FIL Slack
61
- - ask the previous release owner for an invite
62
- - [ ] [access to IPFS network metrics](https://github.com/protocol/pldw/blob/624f47cf4ec14ad2cec6adf601a9f7b203ef770d/docs/sources/ipfs.md#ipfs-network-metrics) dashboards in Grafana
63
- - open an access request in the [pldw](https://github.com/protocol/pldw/issues/new/choose)
64
- - [example](https://github.com/protocol/pldw/issues/158)
65
- - [ ] [kuboreleaser](https://github.com/ipfs/kuboreleaser) checked out on your system (_only if you're using [kuboreleaser](https://github.com/ipfs/kuboreleaser)_)
66
- - [ ] [Thunderdome](https://github.com/ipfs-shipyard/thunderdome) checked out on your system and configured (see the [Thunderdome release docs](./releases_thunderdome.md) for setup)
67
- - [ ] [docker](https://docs.docker.com/get-docker/) installed on your system (_only if you're using [kuboreleaser](https://github.com/ipfs/kuboreleaser)_)
68
- - [ ] [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed on your system (_only if you're **NOT** using [kuboreleaser](https://github.com/ipfs/kuboreleaser)_)
69
- - [ ] [zsh](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH#install-and-set-up-zsh-as-default) installed on your system
70
- - [ ] [kubo](https://github.com/ipfs/kubo) checked out under `$(go env GOPATH)/src/github.com/ipfs/kubo`
71
- - you can also symlink your clone to the expected location by running `mkdir -p $(go env GOPATH)/src/github.com/ipfs && ln -s $(pwd) $(go env GOPATH)/src/github.com/ipfs/kubo`
72
- - [ ]  [Reddit](https://www.reddit.com) account
73
--  Upgrade Go used in CI to the latest patch release available in [CircleCI](https://hub.docker.com/r/cimg/go/tags) in:
74
- - [ ]  [ipfs/distributions](https://github.com/ipfs/distributions)
75
- - [example](https://github.com/ipfs/distributions/pull/756)
76
- - [ ]  [ipfs/ipfs-docs](https://github.com/ipfs/ipfs-docs)
77
- - [example](https://github.com/ipfs/ipfs-docs/pull/1298)
78
-- [ ] Verify there is nothing [left for release](-what-s-left-for-release)
79
-- [ ] Create a release process improvement PR
80
- - [ ] update the [release issue template](docs/RELEASE_ISSUE_TEMPLATE.md) as you go
81
- - [ ] link it in the [Meta](#meta) section
82
-
83
-### The release
24
+* Release PR: <add link once release PR is created>
25
+* Accompanying PR for improving the release process: ([example](https://github.com/ipfs/kubo/pull/9391))
26
85
-This section covers tasks to be done during each release.
27
+# Items In Scope
28
87
-- [ ] Prepare the release branch and update version numbers accordingly <details><summary>using `./kuboreleaser --skip-check-before 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`
91
- - [ ]  update the `CurrentVersionNumber` in [version.go](version.go) in the `master` branch to `vX.Y+1.0-dev`
92
- - [example](https://github.com/ipfs/kubo/pull/9305)
93
- - [ ] update the `CurrentVersionNumber` in [version.go](version.go) in the `release-vX.Y` branch to `vX.Y.Z(-RCN)`
94
- - [example](https://github.com/ipfs/kubo/pull/9394)
95
- - [ ] create a draft PR from `release-vX.Y` to `release`
96
- - [example](https://github.com/ipfs/kubo/pull/9306)
97
- - [ ] Cherry-pick commits from `master` to the `release-vX.Y.Z` using `git cherry-pick -x <commit>`
98
- - [ ]  Add full changelog and contributors to the [changelog](docs/changelogs/vX.Y.md)
99
- - [ ]  Replace the `Changelog` and `Contributors` sections of the [changelog](docs/changelogs/vX.Y.md) with the stdout of `./bin/mkreleaselog`
100
- - do **NOT** copy the stderr
101
- - [ ] verify all CI checks on the PR from `release-vX.Y` to `release` are passing
102
- - [ ]  Merge the PR from `release-vX.Y` to `release` using the `Create a merge commit`
103
- - do **NOT** use `Squash and merge` nor `Rebase and merge` because we need to be able to sign the merge commit
104
- - do **NOT** delete the `release-vX.Y` branch
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>
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)'`
112
- - [ ] ⚠️ verify the tag is signed and tied to the correct commit using `git show vX.Y.Z(-RCN)`
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>
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
-- [ ] 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:`).
120
-- [ ] 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>
121
- - [ ] check out [ipfs/distributions](https://github.com/ipfs/distributions)
122
- - [ ] run `./dist.sh add-version kubo vX.Y.Z(-RCN)` to add the new version to the `versions` file
123
- - [usage](https://github.com/ipfs/distributions#usage)
124
- - [ ] create and merge the PR which updates `dists/kubo/versions` and `dists/go-ipfs/versions` ( and `dists/kubo/current_version` and `dists/go-ipfs/current_version`)
125
- - [example](https://github.com/ipfs/distributions/pull/760)
126
- - [ ] wait for the [CI](https://github.com/ipfs/distributions/actions/workflows/main.yml) workflow run initiated by the merge to master to finish
127
- - [ ] verify the release is available on [dist.ipfs.io](https://dist.ipfs.io/#kubo)
128
- </details>
129
-- [ ] 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` (⚠️ you might need to run the command a couple of times because GHA might not be able to see the new distribution straight away due to caching) or ...</summary>
130
- - [ ] run the [Release to npm](https://github.com/ipfs/npm-go-ipfs/actions/workflows/main.yml) workflow
131
- - [ ] 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
132
- - [ ] verify the release is available on [NPM](https://www.npmjs.com/package/go-ipfs?activeTab=versions)
133
- </details>
134
-- [ ] 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>
135
- - [ ] create a new release on [GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release)
136
- - [RC example](https://github.com/ipfs/kubo/releases/tag/v0.17.0-rc1)
137
- - [FINAL example](https://github.com/ipfs/kubo/releases/tag/v0.17.0)
138
- - [ ] use the `vX.Y.Z(-RCN)` tag
139
- - [ ] link to the release issue
140
- - [ ]  link to the changelog in the description
141
- - [ ]  check the `This is a pre-release` checkbox
142
- - [ ]  copy the changelog (without the header) in the description
143
- - [ ]  do **NOT** check the `This is a pre-release` checkbox
144
- - [ ] run the [sync-release-assets](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) workflow
145
- - [ ] wait for the [sync-release-assets](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) workflow run to finish
146
- - [ ] verify the release assets are present in the [GitHub release](https://github.com/ipfs/kubo/releases/tag/vX.Y.Z(-RCN))
147
- </details>
148
-- [ ] Promote the release <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) promote` or ...</summary>
149
- - [ ] create an [IPFS Discourse](https://discuss.ipfs.tech) topic
150
- - [prerelease example](https://discuss.ipfs.tech/t/kubo-v0-16-0-rc1-release-candidate-is-out/15248)
151
- - [release example](https://discuss.ipfs.tech/t/kubo-v0-16-0-release-is-out/15249)
152
- - [ ] use `Kubo vX.Y.Z(-RCN) is out!` as the title
153
- - [ ] use `kubo` and `go-ipfs` as topics
154
- - [ ] repeat the title as a heading (`##`) in the description
155
- - [ ] link to the GitHub Release, binaries on IPNS, docker pull command and release notes in the description
156
- - [ ] pin the [IPFS Discourse](https://discuss.ipfs.tech) topic globally
157
- - you can make the topic a banner if there is no banner already
158
- - verify the [IPFS Discourse](https://discuss.ipfs.tech) topic was copied to:
159
- - [ ] [#ipfs-chatter](https://discord.com/channels/669268347736686612/669268347736686615) in IPFS Discord
160
- - [ ] [#ipfs-chatter](https://filecoinproject.slack.com/archives/C018EJ8LWH1) in FIL Slack
161
- - [ ] [#ipfs-chatter:ipfs.io](https://matrix.to/#/#ipfs-chatter:ipfs.io) in Matrix
162
- - [ ]  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
163
- - [example](https://github.com/ipfs/kubo/releases/tag/v0.17.0)
164
- - [ ]  create an issue comment mentioning early testers on the release issue
165
- - [example](https://github.com/ipfs/kubo/issues/9319#issuecomment-1311002478)
166
- - [ ]  create an issue comment linking to the release on the release issue
167
- - [example](https://github.com/ipfs/kubo/issues/9417#issuecomment-1400740975)
168
- - [ ]   ask the marketing team to tweet about the release in [#shared-pl-marketing-requests](https://filecoinproject.slack.com/archives/C018EJ8LWH1) in FIL Slack
169
- - [example](https://filecoinproject.slack.com/archives/C018EJ8LWH1/p1664885305374900)
170
- - [ ]   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)
171
- - [example](https://www.reddit.com/r/ipfs/comments/9x0q0k/kubo_v0160_release_is_out/)
172
- </details>
173
-- [ ] Test the new version with `ipfs-companion` <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) test-ipfs-companion` or ...</summary>
174
- - [ ] run the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml)
175
- - use `vX.Y.Z(-RCN)` as the Kubo image version
176
- - [ ] wait for the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml) workflow run to finish
177
- </details>
178
-- [ ]  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>
179
- - [ ] check out [ipfs/ipfs-desktop](https://github.com/ipfs/ipfs-desktop)
180
- - [ ] run `npm install`
181
- - [ ] create a PR which updates `package.json` and `package-lock.json`
182
- - [ ]  add @SgtPooki and @whizzzkid as reviewers
183
- </details>
184
-- [ ]  Update Kubo docs <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) update-ipfs-docs` or ...</summary>
185
- - [ ]  run the [update-on-new-ipfs-tag.yml](https://github.com/ipfs/ipfs-docs/actions/workflows/update-on-new-ipfs-tag.yml) workflow
186
- - [ ]  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
187
- </details>
188
-- [ ]  Ask Brave to update Kubo in Brave Desktop
189
- - [ ]  use [this link](https://github.com/brave/brave-browser/issues/new?assignees=&labels=OS%2FDesktop&projects=&template=desktop.md&title=) to create an issue for the new Kubo version
190
- - [basic example](https://github.com/brave/brave-browser/issues/31453), [example with additional notes](https://github.com/brave/brave-browser/issues/27965)
191
- - [ ]  post link to the issue in `#shared-pl-brave` for visibility
192
-- [ ]  Create a blog entry on [blog.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 PR which adds a release note for the new Kubo version
194
- - [example](https://github.com/ipfs/ipfs-blog/pull/529)
195
- - [ ]  merge the PR
196
- - [ ]  verify the blog entry was published
197
- </details>
198
-- [ ]  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
- - [ ] create a new branch `merge-release-vX.Y.Z` from `release`
200
- - [ ] create and merge a PR from `merge-release-vX.Y.Z` to `master`
201
- </details>
202
-- [ ]   Prepare for the next release <details><summary>using `./kuboreleaser release --version vX.Y.Z(-rcN) prepare-next` or ...</summary>
203
- - [ ]   Create the next [changelog](https://github.com/ipfs/kubo/blob/master/docs/changelogs/vX.(Y+1).md)
204
- - [ ]   Link to the new changelog in the [CHANGELOG.md](CHANGELOG.md) file
205
- - [ ]   Create the next release issue
206
- </details>
207
-- [ ]   Create a dependency update PR
208
- - [ ]   check out [ipfs/kubo](https://github.com/ipfs/kubo)
209
- - [ ]   run `go get -u` in root directory
210
- - [ ]   run `go mod tidy` in root directory
211
- - [ ]   run `go mod tidy` in `docs/examples/kubo-as-a-library` directory
212
- - [ ]   create a PR which updates `go.mod` and `go.sum`
213
- - [ ]   add the PR to the next release milestone
214
-- [ ]  Close the release issue
29
+## Required
30
216
-## How to contribute?
31
+<List of items that MUST be included for the release>
32
218
-Would you like to contribute to the IPFS project and don't know how? Well, there are a few places you can get started:
33
+## Nice To Have (Optional)
34
220
-- Check the issues with the `help wanted` label in the [ipfs/kubo repo](https://github.com/ipfs/kubo/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)
221
-- Join the discussion at [discuss.ipfs.tech](https://discuss.ipfs.tech/) and help users finding their answers.
222
-- See other options at https://docs.ipfs.tech/community/
35
+<List of items that MAY be included for the release>