# ✅ Release Checklist (vX.Y.Z[-rcN]) ## Labels If an item should be executed for a specific release type, it should be labeled with one of the following labels: -  execute **ONLY** when releasing a Release Candidate -  execute **ONLY** when releasing a Final Release Otherwise, it means it should be executed for **ALL** release types. 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: -  do **NOT** execute when releasing a Patch Release ## Before the release This section covers tasks to be done ahead of the release. - [ ] Verify you have access to all the services and tools required for the release - [ ] [GPG signature](https://docs.github.com/en/authentication/managing-commit-signature-verification) configured in local git and in GitHub - [ ] [admin access to IPFS Discourse](https://discuss.ipfs.tech/g/admins) - ask the previous release owner (or @2color) for an invite - [ ]  [access to #shared-pl-marketing-requests](https://filecoinproject.slack.com/archives/C018EJ8LWH1) channel in FIL Slack - ask the previous release owner for an invite - [ ] [access to IPFS network metrics](https://github.com/protocol/pldw/blob/624f47cf4ec14ad2cec6adf601a9f7b203ef770d/docs/sources/ipfs.md#ipfs-network-metrics) dashboards in Grafana - open an access request in the [pldw](https://github.com/protocol/pldw/issues/new/choose) - [example](https://github.com/protocol/pldw/issues/158) - [ ] [kuboreleaser](https://github.com/ipfs/kuboreleaser) checked out on your system (_only if you're using [kuboreleaser](https://github.com/ipfs/kuboreleaser)_) - [ ] [Thunderdome](https://github.com/ipfs-shipyard/thunderdome) checked out on your system and configured (see the [Thunderdome release docs](./releases_thunderdome.md) for setup) - [ ] [docker](https://docs.docker.com/get-docker/) installed on your system (_only if you're using [kuboreleaser](https://github.com/ipfs/kuboreleaser)_) - [ ] [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)_) - [ ] [zsh](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH#install-and-set-up-zsh-as-default) installed on your system - [ ] [kubo](https://github.com/ipfs/kubo) checked out under `$(go env GOPATH)/src/github.com/ipfs/kubo` - 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` - [ ]  [Reddit](https://www.reddit.com) account -  Upgrade Go used in CI to the latest patch release available in [CircleCI](https://hub.docker.com/r/cimg/go/tags) in: - [ ]  [ipfs/distributions](https://github.com/ipfs/distributions) - [example](https://github.com/ipfs/distributions/pull/756) - [ ]  [ipfs/ipfs-docs](https://github.com/ipfs/ipfs-docs) - [example](https://github.com/ipfs/ipfs-docs/pull/1298) - [ ] Verify there is nothing [left for release](-what-s-left-for-release) - [ ] Create a release process improvement PR - [ ] update the [release issue template](docs/RELEASE_ISSUE_TEMPLATE.md) as you go - [ ] link it in the [Meta](#meta) section ## The release This section covers tasks to be done during each release. - [ ] Prepare the release branch and update version numbers accordingly

using `./kuboreleaser --skip-check-before release --version vX.Y.Z(-rcN) prepare-branch` or ...

- [ ] create a new branch `release-vX.Y.Z` - use `master` as base if `Z == 0` - use `release` as base if `Z > 0` - [ ]  update the `CurrentVersionNumber` in [version.go](version.go) in the `master` branch to `vX.Y+1.0-dev` - [example](https://github.com/ipfs/kubo/pull/9305) - [ ] update the `CurrentVersionNumber` in [version.go](version.go) in the `release-vX.Y` branch to `vX.Y.Z(-rcN)` - [example](https://github.com/ipfs/kubo/pull/9394) - [ ] create a draft PR from `release-vX.Y` to `release` - [example](https://github.com/ipfs/kubo/pull/9306) - [ ] Cherry-pick commits from `master` to the `release-vX.Y.Z` using `git cherry-pick -x ` - [ ]  Add full changelog and contributors to the [changelog](docs/changelogs/vX.Y.md) - [ ]  Replace the `Changelog` and `Contributors` sections of the [changelog](docs/changelogs/vX.Y.md) with the stdout of `./bin/mkreleaselog`. Note that the command expects your `$GOPATH/src/github.com/ipfs/kubo` to include latest commits from `release-vX.Y` - do **NOT** copy the stderr - [ ] verify all CI checks on the PR from `release-vX.Y` to `release` are passing - [ ]  Merge the PR from `release-vX.Y` to `release` using the `Create a merge commit` - do **NOT** use `Squash and merge` nor `Rebase and merge` because we need to be able to sign the merge commit - do **NOT** delete the `release-vX.Y` branch

- [ ] Create the release tag

using `./kuboreleaser release --version vX.Y.Z(-rcN) tag` or ...

- This is a dangerous operation! Go and Docker publishing are difficult to reverse! Have the release reviewer verify all the commands marked with ⚠️! - [ ] ⚠️  tag the HEAD commit using `git tag -s vX.Y.Z(-rcN) -m 'Prerelease X.Y.Z(-rcN)'` - [ ] ⚠️  tag the HEAD commit of the `release` branch using `git tag -s vX.Y.Z -m 'Release X.Y.Z'` - [ ] ⚠️ verify the tag is signed and tied to the correct commit using `git show vX.Y.Z(-rcN)` - [ ] ⚠️ push the tag to GitHub using `git push origin vX.Y.Z(-rcN)` - do **NOT** use `git push --tags` because it pushes all your local tags

- [ ] 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:`). - [ ] Publish to Dockerhub, NPM, and dist.ipfs.tech and GitHub using `./kuboreleaser --skip-check-before --skip-run release --version vX.Y.Z(-rcN) publish-to-all` or follow each step below: - [ ] Publish the release to [DockerHub](https://hub.docker.com/r/ipfs/kubo/)

using `./kuboreleaser --skip-check-before --skip-run release --version vX.Y.Z(-rcN) publish-to-dockerhub` or ...

- [ ] Wait for [Publish docker image](https://github.com/ipfs/kubo/actions/workflows/docker-image.yml) workflow run initiated by the tag push to finish - [ ] verify the image is available on [Docker Hub](https://hub.docker.com/r/ipfs/kubo/tags) - [ ] Publish the release to [dist.ipfs.tech](https://dist.ipfs.tech)

using `./kuboreleaser release --version vX.Y.Z(-rcN) publish-to-distributions` or ...

- [ ] check out [ipfs/distributions](https://github.com/ipfs/distributions) - [ ] create new branch: run `git checkout -b release-kubo-X.Y.Z(-rcN)` - [ ] run `./dist.sh add-version kubo vX.Y.Z(-rcN)` to add the new version to the `versions` file - [usage](https://github.com/ipfs/distributions#usage) - [ ] create and merge the PR which updates `dists/kubo/versions` and `dists/go-ipfs/versions` ( and `dists/kubo/current` and `dists/go-ipfs/current`) - [example](https://github.com/ipfs/distributions/pull/760) - [ ] wait for the [CI](https://github.com/ipfs/distributions/actions/workflows/main.yml) workflow run initiated by the merge to master to finish - [ ] verify the release is available on [dist.ipfs.tech](https://dist.ipfs.tech/#kubo)

- [ ] Publish the release to [NPM](https://www.npmjs.com/package/kubo?activeTab=versions)

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 ...

- [ ] run the [Release to npm](https://github.com/ipfs/npm-go-ipfs/actions/workflows/main.yml) workflow - [ ] 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 - [ ] verify the release is available on [NPM](https://www.npmjs.com/package/kubo?activeTab=versions)

- [ ] Publish the release to [GitHub](https://github.com/ipfs/kubo/releases)

using `./kuboreleaser release --version vX.Y.Z(-rcN) publish-to-github` or ...

- [ ] create a new release on [GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release) - [RC example](https://github.com/ipfs/kubo/releases/tag/v0.17.0-rc1) - [FINAL example](https://github.com/ipfs/kubo/releases/tag/v0.17.0) - [ ] use the `vX.Y.Z(-rcN)` tag - [ ] link to the release issue - [ ]  link to the changelog in the description - [ ]  check the `This is a pre-release` checkbox - [ ]  copy the changelog (without the header) in the description - [ ]  do **NOT** check the `This is a pre-release` checkbox - [ ] run the [sync-release-assets](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) workflow - [ ] wait for the [sync-release-assets](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) workflow run to finish - [ ] verify the release assets are present in the [GitHub release](https://github.com/ipfs/kubo/releases/tag/vX.Y.Z(-rcN))

- [ ] Update Kubo staging environment, see the [Running Kubo tests on staging](https://www.notion.so/Running-Kubo-tests-on-staging-488578bb46154f9bad982e4205621af8) for details. - [ ]  Test last release against the current RC - [ ]  Test last release against the current one - [ ] Promote the release

using `./kuboreleaser release --version vX.Y.Z(-rcN) promote` or ...

- [ ] create an [IPFS Discourse](https://discuss.ipfs.tech) topic - [prerelease example](https://discuss.ipfs.tech/t/kubo-v0-16-0-rc1-release-candidate-is-out/15248) - [release example](https://discuss.ipfs.tech/t/kubo-v0-16-0-release-is-out/15249) - [ ] use `Kubo vX.Y.Z(-rcN) is out!` as the title - [ ] use `kubo` and `go-ipfs` as topics - [ ] repeat the title as a heading (`##`) in the description - [ ] link to the GitHub Release, binaries on IPNS, docker pull command and release notes in the description - [ ] pin the [IPFS Discourse](https://discuss.ipfs.tech) topic globally - you can make the topic a banner if there is no banner already - verify the [IPFS Discourse](https://discuss.ipfs.tech) topic was copied to: - [ ] [#ipfs-chatter](https://discord.com/channels/669268347736686612/669268347736686615) in IPFS Discord - [ ] [#ipfs-chatter](https://filecoinproject.slack.com/archives/C018EJ8LWH1) in FIL Slack - [ ] [#ipfs-chatter:ipfs.io](https://matrix.to/#/#ipfs-chatter:ipfs.io) in Matrix - [ ]  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 - [example](https://github.com/ipfs/kubo/releases/tag/v0.17.0) - [ ]  create an issue comment mentioning early testers on the release issue - [example](https://github.com/ipfs/kubo/issues/9319#issuecomment-1311002478) - [ ]  create an issue comment linking to the release on the release issue - [example](https://github.com/ipfs/kubo/issues/9417#issuecomment-1400740975) - [ ]   ask the marketing team to tweet about the release in [#shared-pl-marketing-requests](https://filecoinproject.slack.com/archives/C018EJ8LWH1) in FIL Slack - [example](https://filecoinproject.slack.com/archives/C018EJ8LWH1/p1664885305374900) - [ ]   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) - [example](https://www.reddit.com/r/ipfs/comments/9x0q0k/kubo_v0160_release_is_out/)

- [ ] ~~Test the new version with `ipfs-companion`~~ ([currently skipped](https://github.com/ipfs/ipfs-companion/issues/1300))

using `./kuboreleaser release --version vX.Y.Z(-rcN) test-ipfs-companion` or ...

- [ ] run the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml) - use `vX.Y.Z(-rcN)` as the Kubo image version - [ ] wait for the [e2e](https://github.com/ipfs/ipfs-companion/actions/workflows/e2e.yml) workflow run to finish

- [ ]  Update Kubo in [ipfs-desktop](https://github.com/ipfs/ipfs-desktop)

using `./kuboreleaser release --version vX.Y.Z(-rcN) update-ipfs-desktop` or ...

- [ ] check out [ipfs/ipfs-desktop](https://github.com/ipfs/ipfs-desktop) - [ ] run `npm install` - [ ] create a PR which updates `package.json` and `package-lock.json` - [ ]  add @SgtPooki as reviewer

- [ ]  Update Kubo docs

using `./kuboreleaser release --version vX.Y.Z(-rcN) update-ipfs-docs` or ...

- [ ]  run the [update-on-new-ipfs-tag.yml](https://github.com/ipfs/ipfs-docs/actions/workflows/update-on-new-ipfs-tag.yml) workflow - [ ]  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

- [ ]  Create a blog entry on [blog.ipfs.tech](https://blog.ipfs.tech)

using `./kuboreleaser release --version vX.Y.Z(-rcN) update-ipfs-blog --date YYYY-MM-DD` or ...

- [ ]  create a PR which adds a release note for the new Kubo version - [example](https://github.com/ipfs/ipfs-blog/pull/529) - [ ]  merge the PR - [ ]  verify the blog entry was published

- [ ]  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,

using `./kuboreleaser release --version vX.Y.Z(-rcN) merge-branch` or ...

- [ ] create a new branch `merge-release-vX.Y.Z` from `release` - [ ] create and merge a PR from `merge-release-vX.Y.Z` to `master`

- [ ]   Prepare for the next release

using `./kuboreleaser release --version vX.Y.Z(-rcN) prepare-next` or ...

- [ ]   Create the next [changelog](https://github.com/ipfs/kubo/blob/master/docs/changelogs/vX.(Y+1).md) - [ ]   Link to the new changelog in the [CHANGELOG.md](CHANGELOG.md) file - [ ]   Create the next release issue

- [ ]   Create a dependency update PR - [ ]   check out [ipfs/kubo](https://github.com/ipfs/kubo) - [ ]   go over direct dependencies from `go.mod` in the root directory (NOTE: do not run `go get -u` as it will upgrade indirect dependencies which may cause problems) - [ ]   run `make mod_tidy` - [ ]   create a PR which updates `go.mod` and `go.sum` - [ ]   add the PR to the next release milestone - [ ]  Close the release issue