Release 0.20

[guseggert]

Meta

• Release owner: ???
• Release engineer: @hacdias
• Release reviewer: @galargh
• Expected RC1 date: 2023-04-06
• Expected RC2 date: 2023-04-25
• 🚢 Expected final release date: 2023-04-13 2023-04-27
• Accompanying PR for improving the release process: (example: docs: release process updates from v0.17.0 #9391)
• Accompanying Issue for updating the infra: (example: https://github.com/protocol/bifrost-infra/issues/2221)

See the Kubo release process for more info.

Kubo 0.20.0 Release

We're happy to announce Kubo 0.20.0!

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

🗺 What's left for release

• Release v0.8.0 boxo#250
  • fix from fix(gateway): panic on path without enough components boxo#272 was not present in boxo 0.8.0, we may need a patch release with it
  • similar, traceparent header support on gateway from feat: boxo tracing and traceparent support #9811
• Allow injecting custom path resolvers. #9750
• @guseggert new kad-dht with Optimistic Provide libp2p/go-libp2p-kad-dht#783 and feat: add experimental optimistic provide #9753

🔦 Highlights

< top highlights for this release notes. For ANY version (final or RCs) >

• Release v0.8.0 boxo#250 - boxo 0.8 with repo consolidation and major gateway refactor
• COE action items from DHT events, especially around accelerated DHT client like Move AcceleratedDHTClient from being experimental #9703
• https://github.com/libp2p/go-libp2p/releases/tag/v0.27.0 - libp2p v0.27.0

✅ Release Checklist

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 configured in local git and in GitHub
  • admin access to IPFS Discourse
    • ask the previous release owner (or @2color) for an invite
  • access to #shared-pl-marketing-requests channel in FIL Slack
    • ask the previous release owner for an invite
  • access to IPFS network metrics dashboards in Grafana
    • open an access request in the pldw
    • example
  • kuboreleaser checked out on your system (only if you're using kuboreleaser)
  • docker installed on your system (only if you're using kuboreleaser)
  • npm installed on your system (only if you're NOT using kuboreleaser)
  • zsh installed on your system
  • 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 account
• Upgrade Go used in CI to the latest patch release available in CircleCI in:
  • ipfs/distributions
    • example
  • ipfs/ipfs-docs
    • example
• Verify there is nothing left for release
• Create a release process improvement PR
  • update the release issue template as you go
  • link it in the 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 release --version v0.20.0(-rcN) prepare-branch or ...

  • create a new branch release-v0.20.0
    • use master as base if Z == 0
    • use release as base if Z > 0
  • update the CurrentVersionNumber in version.go in the master branch to v0.21.0-dev
    • example
  • update the CurrentVersionNumber in version.go in the release-v0.20 branch to v0.20.0(-RCN)
    • example
  • create a draft PR from release-v0.20 to release
    • example
  • Cherry-pick commits from master to the release-v0.20.0 using git cherry-pick -x <commit>
  • Add full changelog and contributors to the changelog
    • Replace the Changelog and Contributors sections of the changelog with the stdout of ./bin/mkreleaselog
      • do NOT copy the stderr
  • verify all CI checks on the PR from release-v0.20 to release are passing
  • Merge the PR from release-v0.20 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-v0.20 branch
• Create the release tag
  using kuboreleaser release --version v0.20.0(-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 v0.20.0(-RCN) -m 'Prerelease 0.20.0(-RCN)'
  • ⚠️ tag the HEAD commit of the release branch using git tag -s v0.20.0(-RCN) -m 'Release 0.20.0(-RCN)'
  • ⚠️ verify the tag is signed and tied to the correct commit using git show v0.20.0(-RCN)
  • ⚠️ push the tag to GitHub using git push origin v0.20.0(-RCN)
    • do NOT use git push --tags because it pushes all your local tags
• Publish the release to DockerHub
  using kuboreleaser --skip-check-before --skip-run release --version v0.20.0(-rcN) publish-to-dockerhub or ...

  • Wait for Publish docker image workflow run initiated by the tag push to finish
  • verify the image is available on Docker Hub
• Publish the release to ipfs.tech
  using kuboreleaser release --version v0.20.0(-rcN) publish-to-distributions or ...

  • check out ipfs/distributions
  • run ./dist.sh add-version kubo v0.20.0(-RCN) to add the new version to the versions file
    • usage
  • 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)
    • example
  • wait for the CI workflow run initiated by the merge to master to finish
  • verify the release is available on dist.ipfs.io
• Publish the release to NPM
  using kuboreleaser release --version v0.20.0(-rcN) publish-to-npm or ...

  • run the Release to npm workflow
  • check Release to npm workflow run logs to verify it discovered the new release
  • verify the release is available on NPM
• Publish the release to GitHub
  using kuboreleaser release --version v0.20.0(-rcN) publish-to-github or ...

  • create a new release on GitHub
    • RC example
    • FINAL example
    • use the v0.20.0(-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 workflow
  • wait for the sync-release-assets workflow run to finish
  • verify the release assets are present in the GitHub release
• Promote the release
  using kuboreleaser release --version v0.20.0(-rcN) promote or ...

  • create an IPFS Discourse topic
    • prerelease example
    • release example
    • use Kubo v0.20.0(-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 topic globally
    • you can make the topic a banner if there is no banner already
  • verify the IPFS Discourse topic was copied to:
    • #ipfs-chatter in IPFS Discord
    • #ipfs-chatter in FIL Slack
    • #ipfs-chatter:ipfs.io in Matrix
  • Add the link to the IPFS Discourse topic to the GitHub Release description
    • example
  • create an issue comment mentioning early testers on the release issue
    • example
  • create an issue comment linking to the release on the release issue
    • example
  • ask the marketing team to tweet about the release in #shared-pl-marketing-requests in FIL Slack
    • example
  • post the link to the GitHub Release to Reddit
    • example
• Test the new version with ipfs-companion
  using kuboreleaser release --version v0.20.0(-rcN) test-ipfs-companion or ...

  • run the e2e
    • use v0.20.0(-RCN) as the Kubo image version
  • wait for the e2e workflow run to finish
• Update Kubo in interop
  using kuboreleaser release --version v0.20.0(-rcN) update-interop or ...

  • check out ipfs/interop
  • run npm install
  • create a PR which updates package.json and package-lock.json
  • merge the PR
• Update Kubo in ipfs-desktop
  using kuboreleaser release --version v0.20.0(-rcN) update-ipfs-desktop or ...

  • check out ipfs/ipfs-desktop
  • run npm install
  • create a PR which updates package.json and package-lock.json
  • add @SgtPooki and @whizzzkid as reviewers
• Update Kubo docs
  using kuboreleaser release --version v0.20.0(-rcN) update-ipfs-docs or ...

  • run the update-on-new-ipfs-tag.yml workflow
  • merge the PR created by the update-on-new-ipfs-tag.yml workflow run
• Create a blog entry on ipfs.tech
  using kuboreleaser release --version v0.20.0(-rcN) update-ipfs-blog --date YYYY-MM-DD or ...

  • create a PR which adds a release note for the new Kubo version
    • example
  • merge the PR
  • verify the blog entry was published
• Merge the release branch back into master, ignoring the changes to version.go (keep the -dev) version,
  using kuboreleaser release --version v0.20.0(-rcN) merge-branch or ...

  • create a new branch merge-release-v0.20.0 from release
  • create and merge a PR from merge-release-v0.20.0 to master
• Prepare for the next release
  using kuboreleaser release --version v0.20.0(-rcN) prepare-next or ...

  • Create the next changelog
  • Link to the new changelog in the CHANGELOG.md file
  • Create the next release issue
• Create a dependency update PR
  • check out ipfs/kubo
  • run go get -u in root directory
  • run go mod tidy in root directory
  • run go mod tidy in docs/examples/kubo-as-a-library directory
  • create a PR which updates go.mod and go.sum
  • add the PR to the next release milestone
• Close the release issue

How to contribute?

Would you like to contribute to the IPFS project and don't know how? Well, there are a few places you can get started:

• Check the issues with the help wanted label in the ipfs/kubo repo
• Join the discussion at discuss.ipfs.tech and help users finding their answers.
• See other options at https://docs.ipfs.tech/community/

[guseggert]

placeholder

[galargh]

Dependency upgrade PR: #9744

[BigLep]

I set the expected release date in the issue description.

[guseggert]

Self reminder: add notes in changelog about ipfs/boxo#202 (comment)