⚡️ v0.38.0 RELEASE 🚀

[alanshaw]

TODO short tl;dr; of the release

🗺 What's left for release

• feat: Garbage Collection
  • N.B. Initial implementation adding commands to core, CLI and HTTP API. No automatic or periodic collection.
• fix: ipfs add output fixes
• feat: Gossipsub as default pubsub
• [ ] feat: Config profiles (moved to v0.39.0)
• perf: Add via async iterators
• feat: Support for IPNS and recursive option for ipfs resolve

Future release:

• feat: Enable DHT in client mode
  • feat: Reprovider
• feat: Repo migration tool
• fix: Locking for concurrent pin ops
• fix: Offline blockstore for pinning
• perf: Cache to improve pin performance
• fix: Limit concurrent HTTP requests in browser

🚢 Estimated shipping date

30th September

🔦 Highlights

🏗 API Changes

✅ Release Checklist

• Stage 0 - Automated Testing
  • Feature freeze. If any "non-trivial" changes (see the footnotes of doc/releases.md for a definition) get added to the release, uncheck all the checkboxes and return to this stage.
  • Automated Testing (already tested in CI) - Ensure that all tests are passing, this includes:
    • unit/functional/integration/e2e
    • interop
    • sharness
• Stage 1 - Internal Testing
  • Publish a release candidate to npm

    # Clean out node_modules and re-install dependencies
    # (Ensures you have the latest versions for the browser build)
    rm -rf node_modules package-lock.json
    npm install
    
    # Minor prerelease (e.g. 0.33.1 -> 0.34.0-rc.0)
    npx aegir release --type preminor --preid rc --dist-tag next
    
    # Increment prerelease (e.g. 0.34.0-rc.0 -> 0.34.0-rc.1)
    npx aegir release --type prerelease --preid rc --dist-tag next

  • Network Testing:
    • test lab things - TBD
  • Infrastructure Testing:
    • TBD
  • IPFS Application Testing - Run the tests of the following applications:
    • webui
    • ipfs-desktop
    • ipfs-companion
    • npm-on-ipfs
    • ipfs-pubsub-room
    • peer-base
    • service-worker-gateway
• Stage 2 - Community Dev Testing
  • Reach out to the IPFS early testers listed in doc/EARLY_TESTERS.md for testing this release (check when no more problems have been reported). If you'd like to be added to this list, please file a PR.
  • Reach out on IRC for additional early testers.
  • Run tests available in the following repos with the latest RC:
    • ipfs-log
    • orbit-db
• Stage 3 - Community Prod Testing
  • Documentation
    • Ensure that README.md is up to date
    • Ensure that all the examples run without problems:
      • https://github.com/ipfs/js-ipfs/tree/master/examples/browser-add-readable-stream
      • https://github.com/ipfs/js-ipfs/tree/master/examples/browser-browserify
      • https://github.com/ipfs/js-ipfs/tree/master/examples/browser-mfs
      • https://github.com/ipfs/js-ipfs/tree/master/examples/browser-parceljs
      • https://github.com/ipfs/js-ipfs/tree/master/examples/browser-readablestream
      • https://github.com/ipfs/js-ipfs/tree/master/examples/browser-script-tag
      • https://github.com/ipfs/js-ipfs/tree/master/examples/browser-video-streaming
      • https://github.com/ipfs/js-ipfs/tree/master/examples/browser-vue
      • https://github.com/ipfs/js-ipfs/tree/master/examples/browser-webpack
      • https://github.com/ipfs/js-ipfs/tree/master/examples/circuit-relaying
      • https://github.com/ipfs/js-ipfs/tree/master/examples/custom-ipfs-repo
      • https://github.com/ipfs/js-ipfs/tree/master/examples/custom-libp2p
      • https://github.com/ipfs/js-ipfs/tree/master/examples/exchange-files-in-browser
      • https://github.com/ipfs/js-ipfs/tree/master/examples/explore-ethereum-blockchain
        • Known issue: The "Explore the Ethereum Blockchain" is currently broken #1453
      • https://github.com/ipfs/js-ipfs/tree/master/examples/ipfs-101
      • https://github.com/ipfs/js-ipfs/tree/master/examples/run-in-electron
      • https://github.com/ipfs/js-ipfs/tree/master/examples/running-multiple-nodes
      • https://github.com/ipfs/js-ipfs/tree/master/examples/traverse-ipld-graphs
    • Update js.ipfs.io examples to use the latest js-ipfs
  • Invite the IPFS early testers to deploy the release to part of their production infrastructure.
  • Invite the wider community (link to the release issue):
    • discuss.ipfs.io
    • Twitter
    • IRC
• Stage 4 - Release
  • Take a snapshot of everyone that has contributed to this release (including its direct dependencies in IPFS, libp2p, IPLD and multiformats) using this script.
  • Publish to npm:

    # Clean out node_modules and re-install dependencies
    # (Ensures you have the latest versions for the browser build)
    rm -rf node_modules package-lock.json
    npm install
    
    # lint, build, test, tag, publish
    npm run release-minor

  • Publish a blog post to github.com/ipfs/blog (at minimum, a c&p of this release issue with all the highlights, API changes and thank yous)
  • Broadcasting (link to blog post)
    • Twitter
    • IRC
    • Reddit
    • discuss.ipfs.io
    • Announce it on the IPFS Users Mailing List
  • Copy release notes to the GitHub Release description

❤️ Huge thank you to everyone that made this release possible

• @achingbrain (33 commits, 21 PRs, 7 issues, 46 comments)
• @AcidLeroy (1 comment)
• @alanshaw (50 commits, 25 PRs, 3 issues, 77 comments)
• @andrycodestuffs (1 PR, 2 comments)
• @AuHau (1 PR, 1 issue, 7 comments)
• @bruinxs (1 commit, 1 PR, 1 issue, 1 comment)
• @daviddias (4 commits, 3 PRs, 1 issue, 18 comments)
• @dirkmc (2 commits, 1 comment)
• @geastwood (1 commit, 1 PR)
• @georgeaf99 (1 comment)
• @hacdias (4 commits, 3 PRs)
• @hhfeng (1 comment)
• @hugomrdias (53 commits, 14 PRs, 1 issue, 23 comments)
• @huyanyawei (1 comment)
• @jacobheun (4 commits, 2 PRs, 1 issue, 10 comments)
• @jacogr (1 issue)
• @jgeary (1 issue)
• @jian-en (1 comment)
• @jimpick (1 commit, 1 PR, 3 comments)
• @JustMaier (1 commit, 1 PR)
• @lidel (4 commits, 4 PRs, 2 issues, 18 comments)
• @listenaddress (2 issues)
• @mikeal (1 PR, 7 comments)
• @mitra42 (1 issue, 6 comments)
• @mkg20001 (1 commit, 1 PR, 1 issue, 2 comments)
• @Nashatyrev (1 issue)
• @olizilla (10 comments)
• @pruflyos (1 comment)
• @rabrux (1 comment)
• @robertkiel (1 PR)
• @rvagg (1 comment)
• @samparsky (18 PRs)
• @Stebalien (5 comments)
• @tapaswenipathak (1 PR, 1 comment)
• @teddycode (1 issue)
• @terichadbourne (1 issue)
• @vasa-develop (1 comment)
• @vasco-santos (18 commits, 11 PRs, 18 comments)
• @vmx (2 commits, 3 PRs, 1 comment)
• @x5engine (1 comment)
• @yehia67 (2 comments)
• @yuwiggin (1 comment)

🙌🏽 Want 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 js-ipfs repo
• Join an IPFS All Hands, introduce yourself and let us know where you would like to contribute - https://github.com/ipfs/team-mgmt/#weekly-ipfs-all-hands
• Hack with IPFS and show us what you made! The All Hands call is also the perfect venue for demos, join in and show us what you built
• Join the discussion at https://discuss.ipfs.io/ and help users finding their answers.
• Join the 🚀 IPFS Core Implementations Weekly Sync 🛰 and be part of the action!

⁉️ Do you have questions?

The best place to ask your questions about IPFS, how it works and what you can do with it is at discuss.ipfs.io. We are also available at the #ipfs channel on Freenode.

[alanshaw]

🚢 There's a pre-release version available for testing with the GC work in it 0.38.0-pre.0

[alanshaw]

🐣 0.38.0-pre.1 is now available for testing with the gossipsub implementation!

[achingbrain]

🐤 0.38.0-rc.0 has been published!

[daviddias]

@achingbrain can you include #2428 so that it unblocks all the work on improved testing #2276?

[achingbrain]

I'd rather not because the build for that PR is failing, 0.38.0 is in feature-freeze and what's the point of having this fancy new release process if we ignore it the first time we try to use it? 🤪

[achingbrain]

In all honesty stages 2 & 3 are likely to be very short as the early testers list is pretty short so we can always start the 0.39.0 release process early once CI is happy again.

[achingbrain]

🐥 0.38.0-rc.1 has been published!

[achingbrain]

Also, the release is being done from a branch - v0.38.x so as soon as CI is green on #2428 it can go into master and unblock work that depends on it without holding up v0.38.x. It'll then go out in v0.39.0 along with whatever else.

[achingbrain]

A little late, but:

🐔 0.38.0-rc.2 has been published!
🐓 0.38.0-rc.3 has been published!
🍗 0.38.0-rc.4 has been published!

(running out of chicken emojis, sorry)

[achingbrain]

🍟 0.38.0-rc.5 has been published!

This is planned to be the last rc before release and contains up to date documentation.

[achingbrain]

🚢It ship! https://www.npmjs.com/package/ipfs/v/0.38.0

[daviddias]

@achingbrain does the number of unchecked boxes represent reality?

[achingbrain]

More or less? It's up to date now.

I left the stage headline checkbox unchecked if there were any steps missing so we have an easy view on what to improve next time.