Release 0.37

[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: ~ 19th
• 🚢 Expected final release date: ~27th
• Release PR: Release v0.37.0 #10930
• Accompanying PR for improving the release process: docs: simplify release process #10870
• Internal Staging tests by Shipyard: 0.36.0 vs 0.37.0-rc1-255bc88
• Changelog: https://github.com/ipfs/kubo/blob/master/docs/changelogs/v0.37.md

Items In Scope

Required

• feat(config): AutoConf with "auto" placeholders #10883
• feat(config): Gateway.RetrievalTimeout|MaxConcurrentRequests #10905
  • boxo with feat(gateway): concurrency and timeout limits boxo#994
    • boxo with gateway: ability to set response write timeout boxo#679
    • boxo with gateway: limit the number of requests in flight boxo#881
  • provider: clear provide queue when reprovide strategy changes #10863
• feat: ipfs-webui v4.8.0 #10902 with
  • fix: refresh stale multiaddrs on the Status page ipfs-webui#2385 to pick up AutoTLS/RelayV2 changes
  • feat: add async provide on share/copy/pin/ipns ipfs-webui#2387 to help users who dont run nodes all the time, and want to quickly start node and share CID
  • fix: stop sending requests to defunct countly ipfs-webui#2395
• chore: update go-libp2p and p2p-forge #10887 & Upgrade to Boxo v0.33.1 #10888
  • feat: go-libp2p v0.43.0 #10892 (https://github.com/quic-go/quic-go/releases/tag/v0.54.0)
  • p2p-forge/client v0.6.1+ with fix: addrs factory skipping logic ipshipyard/p2p-forge#76
• feat: add query functionality to log level command #10885
• fix: ipfs cid without repo #10897 & fix(cmd): exit 1 on error #10903
• fix: Provide according to Reprovider.Strategy #10886
• fix(relay): feed connected peers to AutoRelay discovery #10901
• fix: Windows symlink handling and error recovery npm-kubo#76
• feat: telemetry plugin #10866

Nice To Have (Optional)

• feat: require go1.25 for building kubo #10913
• feat(ipns): support passing custom sequence number during publishing #10851
• fix: move non-error log to warning level libp2p/go-libp2p-kad-dht#1119
• refactor: remove goprocess #10872
• refactor: remove goprocess #10872
• Add /api/v0/log API for querying current log levels #10882
• feat(daemon): accelerated client startup note #10859
• feat(add): add support for naming pinned CIDs #10877
• Add Routing.Type=delegated to only use Routing.DelegatedRouters #10824
• TBD work related to routing/provider (likely needs more work, ETA ~0.38)
  • Merge "all" and "flat" reprovider strategies #10864
  • Move ipfs routing provide and reprovide into ipfs provide namespace #10865
  • TBD Provide newly received blocks according to reprovide strategy #10837
  • Integrate Modernized Provider System from go-libp2p-kad-dht #10881
• other kad-dht provider/reprovider improvements
  • feat: opt-in new Sweep provide system #10834 (wip, likely 0.37+)
    • feat: Reprovide Sweep libp2p/go-libp2p-kad-dht#1082
    • (parked until reprovider refactor) provider: duplicated CIDs sent to provide queue boxo#901
    • (parked until reprovider refactor) Command to clean reprovider queue #10829
• feat(mfs): chroot command to change the root #8648
• bug: failed to establish port mapping: goupnp: error performing SOAP HTTP request after LAN (upnp) router restart #9759
• feat(mfs): chroot command to change the root #8648 as fix for Ipfs daemon hangs when MFS root is not available locally #7183 (comment)
• Deployment plan for AutoNAT v2 #10091
  • update go-libp2p to version that uses AutoNATv2 for everything
• 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
• refactor: support percent-encoded /unix paths #10833

[lidel]

✅ Release Checklist (v0.37.0-rc1)

• 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
  • 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 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
  • ⚠️ 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)
  • 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.
  • 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 (NOTE: will also have dists/kubo/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 if it was not executed already and verify it discovered the new release
  • verify the release is available on NPM
• Publish the release to GitHub kubo/releases
  • create a new release
    • 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 and verify the release assets are attached to 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 ipshipyard/waterworks-infra
  • 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
  • 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 topic (prerelease example, release example)
    • 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 topic globally, you can make the topic a banner if there is no banner already
  • verify the IPFS Discourse topic was posted by a chatbot to #ipfs-chatter in IPFS Discord or #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)
  • (optional) promote on bsky.app (example)
  • (optional) promote on x.com (example)
  • (optional) post to Reddit
• Manually smoke-test the new version with IPFS Companion Browser Extension
• Update Kubo in ipfs-desktop
  • create a PR which updates kubo version to the tagged version in package.json and package-lock.json
  • merge and create or request a new release
• Update Kubo docs at docs.ipfs.tech: run the update-on-new-ipfs-tag.yml workflow and merge the PR it creates
• Create a blog entry on blog.ipfs.tech: create a PR which adds a release note for the new Kubo version (example), merge it, and 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]

Early testers ping for 0.37.0-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. Please open a PR to update that list if you no longer want to be included.