Release 0.18.1

[BigLep]

Meta

• Release owner: @galargh
• Release reviewer: @ajnavarro
• Expected release date: 2023-01-27 2023-01-30
• Process improvement PR: Process Improvement: v0.18.0 #9484
• bifrost issue: https://github.com/protocol/bifrost-infra/issues/2319

See the Kubo release process for more info.

Purpose

• Unblock key partner (Ceramic) with upcoming launches/demos.
• Address remaining low-hanging UX issues with ResourceMgr changes that still remain in 0.18.

Items in scope

Tasks

Beta Give feedback

1. Use updated pubsub time cache implementation #9542
   P2 exp/intermediate kind/enhancement +3
2. ResourceManager: Adjust inbound connection limits depending on memory. #9593
   +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 #bifrost channel in FIL Slack
    • ask the previous release owner 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
  • npm installed on your system (only if you're not using kuboreleaser)
  • zsh installed on your system (only if you're not using kuboreleaser)
  • kubo checked out under $(go env GOPATH)/src/github.com/ipfs/kubo (only if you're not using kuboreleaser)
    • 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
  • ipfs/distributions
    • example
  • ipfs/ipfs-docs
    • example
• Notify the bifrost team about the upcoming release
  using kuboreleaser release --version vX.Y.Z(-RCN) notify-bifrost --date YYYY-MM-DD or ...

  • open an issue against bifrost-infra
    • example
• Link the bifrost-infra issue in the Meta section
• 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.

• Cut the release branch and update version numbers accordingly
  using kuboreleaser release --version vX.Y.Z(-RCN) cut-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 in the master branch to vX.(Y+1).0-dev
    • example
  • update the CurrentVersionNumber in version.go in the release-vX.Y branch to vX.Y.Z(-RCN)
    • example
  • create a draft PR from release-vX.Y to release
    • example
  • verify all CI checks on the PR from release-vX.Y to release are passing
• Cherry-pick commits from master to the release-vX.Y.Z using git cherry-pick -x <commit>
• Add full changelog and contributors to the changelog
  • Paste the stdout of ./bin/mkreleaselog at the end of the changelog
    • do NOT copy the stderr
• 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(-RCN) -m 'Release X.Y.Z(-RCN)'
  • ⚠️ 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
• 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 vX.Y.Z(-RCN) publish-to-distributions or ...

  • check out ipfs/distributions
  • run ./dist.sh add-version kubo vX.Y.Z(-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
    • 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 vX.Y.Z(-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 vX.Y.Z(-RCN) publish-to-github or ...

  • create a new release on GitHub
    • RC example
    • FINAL example
    • 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 workflow
  • wait for the sync-release-assets workflow run to finish
  • verify the release assets are present in the GitHub release
• Notify the bifrost team about the release
  using kuboreleaser release --version vX.Y.Z(-RCN) notify-bifrost --date YYYY-MM-DD or ...

  • create an issue comment on the issue in the bifrost-infra
• Promote the release
  using kuboreleaser release --version vX.Y.Z(-RCN) promote or ...

  • create an IPFS Discourse topic
    • prerelease example
    • release example
    • 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 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
  • 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
• Add the link to the IPFS Discourse topic to the GitHub Release description
  • example
• Test the new version with ipfs-companion
  using kuboreleaser release --version vX.Y.Z(-RCN) test-ipfs-companion or ...

  • run the e2e
    • use vX.Y.Z(-RCN) as the Kubo image version
  • wait for the e2e workflow run to finish
• Update Kubo in interop
  using kuboreleaser release --version vX.Y.Z(-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 vX.Y.Z(-RCN) update-ipfs-desktop or ...

  • check out ipfs/ipfs-desktop
  • run npm install
  • create a PR which updates package.json and package-lock.json
  • merge the PR
• Update Kubo docs
  using kuboreleaser release --version vX.Y.Z(-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 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
  • merge the PR
  • verify the blog entry was published
• Keep checking the metrics until the release issue is closed
  • release notes
  • post in the #bifrost channel in FIL Slack if there is a problem
• Merge the release branch back into master, ignoring the changes to 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
• 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 -t -u ./...
  • create a PR which updates go.mod and go.sum
  • add the PR to the next release milestone
• Close the release issue

[BigLep]

For anyone watching, we're intending to do this release on 2023-01-27 (assuming the items in scope land then).

[BigLep]

We are ready to do the release on Monday (as just need to merge #9593).

[galargh]

🎉 Kubo v0.18.1 is out!

[galargh]

The release is complete 🥳 One outstanding item to track beyond this issue is rollout to PL infra - https://github.com/protocol/bifrost-infra/issues/2319