Release 0.34

[lidel]

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

Meta

• Release owner: @lidel
• Release reviewer/backup: @gammazero
• Expected RC1 date: 6th
• Expected RC2 date: 13th
• 🚢 Expected final release date: 19th
• Release PR: Release v0.34.0 #10745, Release v0.34.1 #10764
• Accompanying PR for improving the release process: N/A
• Internal Staging tests by Shipyard: https://www.notion.so/Kubo-0-33-2-vs-0-34-x-1a61def342878015b32ce735c2a89a23
• Changelog: https://github.com/ipfs/kubo/blob/master/docs/changelogs/v0.34.md

Items In Scope

Required

• boxo with goroutine leak fix
  • fix: bitswap lock contention under high load boxo#817 should also make below ones disappear - if so, close them
  • "autonat" and "autonatv2/autonat.go-L132" is a slow consumer of event.EvtPeer* libp2p/go-libp2p#3120
  • go-libp2p-kad-dht/subscriber_notifee.go-L37" is a slow consumer of event.EvtPeer*  libp2p/go-libp2p-kad-dht#1007
  • fix(bitswap): blockpresencemanager leak boxo#833
  • feat: Prevent multiple instances of "ipfs routing reprovide" running together. boxo#834
• fix(ipns): reading records with raw []byte Value boxo#830
• fix(rpc): restore and deprecate bitswap reprovide #10699
• chore: go-libp2p v0.39.0 #10703
• go-libp2p wss bug that made bootstrappers die after ~1 day (internal)
  • fix: go-libp2p v0.39.1 #10711
• fix(client): DNS-01 TXT record check ipshipyard/p2p-forge#57
• chore: remove 386 build target distributions#1129
• new webui feat: ipfs-webui v4.5.0 #10735 with:
  • fix(peers): chrome regression and update ipfs-geoip to v9.2 ipfs-webui#2333
  • feat: add QR Code to ShareModal ipfs-webui#2320
• Upgrade to go-libp2p v0.40.0 #10727
• chore: update kad-dht #10732
• Upgrade to Boxo v0.28.0 #10725
• chore: update go-libp2p to v0.41.0 #10733
• accelerated client includes outdated(?) addrs #10737
  • potential fix: fix: crawler polluting peerstore libp2p/go-libp2p-kad-dht#1053
• goroutine runaway on kubo staging 02 (internal notes)
  • potential fix: minimize peermanager lock scope boxo#860
• https://github.com/libp2p/go-libp2p-kad-dht/releases/tag/v0.30.0
• docs(config): add security considerations for rpc #10739
• use go-datastore without go-process #10736
• Upgrade to Boxo v0.29.0 #10742
• decide if pin buffer provider goes in
  • ba22102
  • docs(readme): update min. requirements + cleanup #10750
• feat: ipfs-webui v4.6 #10756

Nice To Have (Optional)

• Reprovide.Interval 0 seems ignored on staging? #10714
• webui with feat(files): CAR Import ipfs-webui#2323
• Add MFS Support to Reprovider Strategy #10704
  • feat: NewDAGProvider to walk partial DAGs in offline mode boxo#847
• TBD if we need gateway: range requests issue with big >5GiB files boxo#856
• chore: Basic UnixFS sanity checks #10701
• chore(identify): move log to debug level libp2p/go-libp2p#3206
• ipns publish: lower the default TTL #10718
  • chore(ipns): lower DefaultRecordTTL to 5m boxo#859
• 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)
• AutoTLS
  • AutoTLS: attempts to get cert when not publicly diallable #10570
• 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
• Add basic UnixFS sanity check to 'ipfs files cp' #10331
• Prevent multiple instances of "ipfs bitswap reprovide" running at the same time #10513
• gateway/blocks-backend: GetBlock should not perform IPLD decoding boxo#673
• feat: partial DAG provides with Reprovider.Strategy=mfs|pinned+mfs #10754
• fix(gateway): preserve query parameters on _redirects boxo#886

[lidel]

We are investigating some regressions on staging environment, RC1 may be delayed until we understand what caused them (go-libp2p update? boxo? go 1.24?). We also noticed accelerated client is gathering too many addrs, looking into that as well.

If anyone wants to start testing features like AutoTLS enabled by default sooner, the docker image is ipfs/kubo:master-2025-02-25-baa94fc

[lidel]

✅ Release Checklist (v0.34.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.34.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.

[lidel]

✅ Release Checklist (v0.34.0-rc2)

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.34.0-rc2 is out!

[lidel]

✅ Release Checklist (v0.34.0 FINAL)

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