Release 0.35

[lidel]

Part of ongoing maintenance of key libraries and services ipshipyard/roadmaps#1 and ipshipyard/roadmaps#6

Meta

• Release owner: @lidel
• Release reviewer/backup: @gammazero
• Expected RC1 date: ~ May 7-8th
• 🚢 Expected final release date: May 21st
• Release PR: Release v0.35.0 #10799
• Accompanying PR for improving the release process: N/A
• Internal Staging tests by Shipyard: notion
• Changelog: https://github.com/ipfs/kubo/blob/master/docs/changelogs/v0.35.md

Items In Scope

Required

This release will focus on provider system improvements and HTTP retrieval (opt-in)

• feat: partial DAG provides with Reprovider.Strategy=mfs|pinned+mfs #10754
• feat: ipfs-webui v4.7.0 #10780 with feat: Add thumbnails support for files in grid view ipfs-webui#2337
• boxo with Improve performance of data onboarding boxo#888
  • changelog: re-test ipfs add and add section to changelog
• boxo with fix(gateway): preserve query parameters on _redirects boxo#886
• boxo with provider: simplify reprovide boxo#890
• boxo with provider: duplicated CIDs sent to provide queue boxo#901
  • and fix for tests: ensure kubo is providing cid only once #10784, perhaps provider: deduplicate cids in queue boxo#910
    • feat: Provider.WorkerCount and stats reprovide cmd #10779 with provider: dedicated provide queue boxo#907
• switch to boxo release Upgrade to Boxo v0.30.0 #10794
• ipfs add: parameter to control the width of created UnixFS DAG #10751
• Opt-in HTTP retrieval (introduced in HTTP retrieval proposal boxo#747)
  • feat: opt-in http retrieval client #10772
• feat(pebble): support pinning FormatMajorVersion #10789
• kad-dht upgrade chore: release v0.31.1 libp2p/go-libp2p-kad-dht#1079

Bugs in RC1 fixed in RC2

• kubo 0.35.0-rc1: missing Provide.Enabled flag #10803
  • fix(config): wire up Provider.Enabled flag #10804
• fix(fuse): ipns error handling and friendly errors #10807

Bugs in RC2

• fix: go-libp2p-kad-dht v0.33.1 #10814
  • fix: fullrt kMapLk unlock libp2p/go-libp2p-kad-dht#1085
  • testing image: fix: go-libp2p-kad-dht#1085 #10812
• fix(autotls): ignore /p2p-circuit addrs #10813
  • fix(client): filter out public /p2p-circuit addrs ipshipyard/p2p-forge#68

Nice To Have (Optional)

• feat(fuse): Expose MFS as FUSE mount point #10781
• boxo with feat(gateway): add cid copy button to directory listings  boxo#899
• config: Flag to disable Bitswap client and server #10717
• feat(config): expose ProviderSearchMaxResults #10773
• document docs: known issues with file/urlstores #10768
• Reprovide.Interval 0 seems ignored on staging? #10714
• TBD if we need gateway: range requests issue with big >5GiB files boxo#856
• feat(cmds): files: add new-root command to change the MFS root #8648 as fix for Ipfs daemon hangs when MFS root is not available locally #7183 (comment)
• Deployment plan for AutoNAT v2 #10091
  • AutoTLS: attempts to get cert when not publicly diallable #10570 (depends on autonatv2 client)
• Denylist support fixes and improvements
  • ipfs blockservice is incompatible with sessions ipfs-shipyard/nopfs#34 (NOfs content filtering is not applied to bitswap)
  • Support consuming https://badbits.dwebops.pub/badbits.deny rainbow#126 (same applies to Kubo)
    • denylist: ?format=car does not skip directly blocked CIDs #10361
    • HTTPSubscriber: detect when list is not append-only ipfs-shipyard/nopfs#39
    • HTTPSubscriber: check with If-None-Match or If-Modified-Since ipfs-shipyard/nopfs#38
• Update pubsub and add default validator #9684 + update to v0.12.0 with GossipSub v1.2 + 0.13.0
• TBD: turn Experimental.GatewayOverLibp2p=true into opt-in feature
  • this is "http over libp2p stream" instead of "http-only gateways + tls" – think about it as bitswap replacement, that can reuse HTTP client logic from HTTPSwap, but make requests over libp2p. the use case for this is to provide bitswap replacement for users who can't run http-only endpoint for some reason
  • we start rolling out server before client exists to ensure we can enable client in the future, and have working servers for testing
  • this is an opportunity to flesh out how Exchange.* will look like (with bitswap client|server, HTTPGatewayOverLibp2p server for now, and HTTPSwap client)
• feat(cmds): files: add new-root command to change the MFS root #8648
• datastore: metrics datastore configuration optional and off by default #10788
• bug: failed to establish port mapping: goupnp: error performing SOAP HTTP request after LAN (upnp) router restart #9759
• chore: use go-log/v2 #10801 (note: pushed to 0.36)

[lidel]

We've landed nearly everything in master branch, HTTP retrieval remains in #10772, needs E2E test to be fixed.

Planning RC1 next week (Thu-Wed, depending how long it takes to figure out the E2E test)

[lidel]

All required changes are in master branch 🎉
Changelog draft: https://github.com/ipfs/kubo/blob/master/docs/changelogs/v0.35.md
We will likely cut 0.35.0-rc1 tomorrow (Wed 7th)

[lidel]

✅ Release Checklist (v0.35.0-rc1)

1. Prepare release branch

• 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
  • 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.Z branch to vX.Y.Z(-rcN) (example)
  • create a draft PR from release-vX.Y.Z to release (example)
  • Cherry-pick commits from master to the release-vX.Y.Z using git cherry-pick -x <commit> (example)
    • NOTE: cherry-picking with -x is important
  • Replace the Changelog and Contributors sections of the changelog 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
  • 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
  • ⚠️ 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'
  • ⚠️ 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

3. Publish

• Publish Docker image to DockerHub
  • Wait for Publish docker image workflow run initiated by the tag push to finish
  • verify the image is available on Docker Hub → tags
• Publish the release to dist.ipfs.tech
  • check out 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)
  • Verify ipfs/distributions's .tool-versions's golang entry is set to the latest go release on the major go branch Kubo is being tested on (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)
  • wait for the CI workflow run initiated by the merge to master to finish
  • verify the release is available on dist.ipfs.tech
• Publish the release to NPM
  • manually dispatch 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 kubo/releases
  • create a new release on github.com/ipfs/kubo/releases
    • 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

4. After Publishing

• Merge the release branch back into master
  • Create a new branch merge-release-vX.Y.Z from release
  • Create the next ./docs/changelogs/vA.B.md and link to the new changelog from the ./CHANGELOG.md file
  • 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 (keep the -dev in master)
• Update Kubo staging environment, see the Running Kubo tests on staging for details.
  • Test last release against the current RC
  • Test last release against the current one
• Promote the release
  • create an IPFS Discourse topic (prerelease example, release example)
    • use Kubo vX.Y.Z(-rcN) is out! as the title and kubo and go-ipfs 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 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)
  • promote on bsky.app (example)
  • promote on x.com (example)
  • post the link to the GitHub Release to Reddit (example)
• Manually smoke-test the new version with IPFS Companion Browser Extension
• Update Kubo in ipfs-desktop
  • check out ipfs/ipfs-desktop
  • run npm install
  • create a PR which updates package.json and package-lock.json
• Update Kubo docs at docs.ipfs.tech:
  • 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 blog.ipfs.tech
  • create a PR which adds a release note for the new Kubo version (example)
  • merge the PR
  • verify the blog entry was published
• Create a dependency update PR
  • check out 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
• Create the next release issue
• Close the release issue

[lidel]

Kubo v0.35.0-rc1 is out!

Early testers ping for RC1 testing:

• Charity Engine (@Rytiss, @tristanolive)
• Fission (@bmann)
• Infura (@MichaelMure)
• OrbitDB (@haydenyoung)
• Pinata (@obo20)
• Shipyard (@cewood, @ns4plabs)
• Siderus (@koalalorenzo)
• Textile (@sanderpick)
• @RubenKelevra

You're getting this message because you're listed here. Open PR to update that list if you no longer want to be included in these pings.