mirror of
https://github.com/ipfs/kubo.git
synced 2026-03-05 16:28:06 +08:00
docs: release checklist fixes from 0.36 (#10861)
This commit is contained in:
Marcin Rataj
GitHub
parent
b4e6769a56
commit
475e2bad67
@ -1,4 +1,4 @@
|
||||
<!-- Last updated during [v0.33.0 release](https://github.com/ipfs/kubo/pull/10674) -->
|
||||
<!-- Last updated during [v0.36.0 release](https://github.com/ipfs/kubo/issues/10816) -->
|
||||
|
||||
# ✅ Release Checklist (vX.Y.Z[-rcN])
|
||||
|
||||
@ -30,7 +30,7 @@ This section covers tasks to be done during each release.
|
||||
|
||||
### 1. Prepare release branch
|
||||
|
||||
- [ ] Prepare the release branch and update version numbers accordingly
|
||||
- [ ] Prepare the release branch and update version numbers accordingly
|
||||
- [ ] create a new branch `release-vX.Y.Z`
|
||||
- use `master` as base if `Z == 0`
|
||||
- use `release` as base if `Z > 0`
|
||||
@ -39,16 +39,16 @@ This section covers tasks to be done during each release.
|
||||
- [ ] create a draft PR from `release-vX.Y.Z` 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 <commit>` ([example](https://github.com/ipfs/kubo/pull/10636/commits/033de22e3bc6191dbb024ad6472f5b96b34e3ccf))
|
||||
- **NOTE:** cherry-picking with `-x` is important
|
||||
- [ ]  Replace the `Changelog` and `Contributors` sections of the [changelog](docs/changelogs/vX.Y.md) with the stdout (do **NOT** copy the stderr) of `./bin/mkreleaselog`.
|
||||
- **NOTE:** `mkreleaselog` expects your `$GOPATH/src/github.com/ipfs/kubo` to include latest commits from `release-vX.Y.Z`
|
||||
- [ ] verify all CI checks on the PR from `release-vX.Y.Z` to `release` are passing
|
||||
- [ ]  Replace the `Changelog` and `Contributors` sections of the [changelog](docs/changelogs/vX.Y.md) with the stdout (do **NOT** copy the stderr) of `./bin/mkreleaselog`.
|
||||
- **NOTE:** `mkreleaselog` expects your `$GOPATH/src/github.com/ipfs/kubo` to include latest commits from `release-vX.Y.Z`
|
||||
- [ ]  Merge the PR from `release-vX.Y.Z` 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.Z` branch
|
||||
|
||||
### 2. Tag release
|
||||
|
||||
- [ ] Create the release tag
|
||||
- [ ] Create the release tag
|
||||
- ⚠️ **NOTE:** 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'`
|
||||
@ -61,31 +61,28 @@ This section covers tasks to be done during each release.
|
||||
- [ ] Publish Docker image to [DockerHub](https://hub.docker.com/r/ipfs/kubo/tags)
|
||||
- [ ] 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 → tags](https://hub.docker.com/r/ipfs/kubo/tags)
|
||||
- [ ] Publish the release to [dist.ipfs.tech](https://dist.ipfs.tech)
|
||||
- [ ] Publish the release to [dist.ipfs.tech](https://dist.ipfs.tech)
|
||||
- [ ] 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 new branch: run `git checkout -b release-kubo-X.Y.Z(-rcN)`
|
||||
- [ ] 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:`). If not, update `.tool-versions` to match the latest golang.
|
||||
- [ ] create and merge the PR which updates `dists/kubo/versions` and `dists/go-ipfs/versions` (**NOTE:**  will also have `dists/kubo/current` and `dists/go-ipfs/current` – [example](https://github.com/ipfs/distributions/pull/1125))
|
||||
- [ ] 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` (**NOTE:**  will also have `dists/kubo/current` – [example](https://github.com/ipfs/distributions/pull/1125))
|
||||
- [ ] 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)
|
||||
- [ ] manually dispatch 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
|
||||
- [ ] manually dispatch the [Release to npm](https://github.com/ipfs/npm-kubo/actions/workflows/main.yml) workflow if it was not executed already and 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 kubo/releases](https://github.com/ipfs/kubo/releases)
|
||||
- [ ] create a new release on [github.com/ipfs/kubo/releases](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)
|
||||
- [ ] [create](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#creating-a-release) a new release
|
||||
- [RC example](https://github.com/ipfs/kubo/releases/tag/v0.36.0-rc1)
|
||||
- [FINAL example](https://github.com/ipfs/kubo/releases/tag/v0.35.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))
|
||||
- [ ] run the [sync-release-assets](https://github.com/ipfs/kubo/actions/workflows/sync-release-assets.yml) workflow and verify the release assets are attached to the GitHub release
|
||||
|
||||
### 4. After Publishing
|
||||
|
||||
@ -95,12 +92,15 @@ This section covers tasks to be done during each release.
|
||||
- [ ] Create and merge a PR from `merge-release-vX.Y.Z` to `master`
|
||||
- ⚠️ do **NOT** use `Squash and merge` nor `Rebase and merge` because we need to be able to sign the merge commit
|
||||
- ⚠️ **NOTE:** make sure to ignore the changes to [version.go](version.go) (keep the `-dev` in `master`)
|
||||
- [ ] 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
|
||||
- [ ] Update [ipshipyard/waterworks-infra](https://github.com/ipshipyard/waterworks-infra)
|
||||
- [ ] 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
|
||||
- [ ] Update collab cluster boxes to the tagged release (final or RC)
|
||||
- [ ] Update libp2p bootstrappers to the tagged release (final or RC)
|
||||
- [ ] Promote the release
|
||||
- [ ] 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 and `kubo` and `go-ipfs` as tags
|
||||
- [ ] use `Kubo vX.Y.Z(-rcN) is out!` as the title and `kubo` as tags
|
||||
- [ ] 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
|
||||
@ -112,25 +112,24 @@ This section covers tasks to be done during each release.
|
||||
- [ ]  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))
|
||||
- [ ]   promote on bsky.app ([example](https://bsky.app/profile/ipshipyard.com/post/3lh2brzrwbs2c))
|
||||
- [ ]   promote on x.com ([example](https://x.com/ipshipyard/status/1885346348808929609))
|
||||
- [ ]   promote on x.com ([example](https://x.com/ipshipyard/status/1885346348808929609))
|
||||
- [ ]   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/))
|
||||
- [ ] Manually smoke-test the new version with [IPFS Companion Browser Extension](https://docs.ipfs.tech/install/ipfs-companion/)
|
||||
- [ ]  Update Kubo in [ipfs-desktop](https://github.com/ipfs/ipfs-desktop)
|
||||
- [ ] 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`
|
||||
- [ ] Update Kubo in [ipfs-desktop](https://github.com/ipfs/ipfs-desktop)
|
||||
- [ ] create a PR which updates `kubo` version to the tagged version in `package.json` and `package-lock.json`
|
||||
- [ ]  switch to final release and merge
|
||||
- [ ]  Update Kubo docs at docs.ipfs.tech:
|
||||
- [ ]  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
|
||||
</details>
|
||||
- [ ]  Create a blog entry on [blog.ipfs.tech](https://blog.ipfs.tech)
|
||||
- [ ]  Create a blog entry on [blog.ipfs.tech](https://blog.ipfs.tech)
|
||||
- [ ]  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
|
||||
- [ ]   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`
|
||||
- [ ]   run `make mod_tidy`
|
||||
- [ ]   create a PR which updates `go.mod` and `go.sum`
|
||||
- [ ]   add the PR to the next release milestone
|
||||
- [ ]   Create the next release issue
|
||||
|
||||
Loading…
Reference in New Issue
Block a user