Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

track: multiformats upgrade #3701

Closed
20 tasks done
achingbrain opened this issue May 26, 2021 · 3 comments
Closed
20 tasks done

track: multiformats upgrade #3701

achingbrain opened this issue May 26, 2021 · 3 comments
Assignees
Labels
awesome endeavour exp/intermediate Prior experience is likely helpful status/in-progress In progress

Comments

@achingbrain
Copy link
Member

achingbrain commented May 26, 2021

This issue is to track the upgrade from ipld-dag-* formats to block codecs from the multiformats module.

Why

  • The ipld-dag-* are no longer maintained - development focus is now centred on multiformats and the @ipld/dag-* modules
  • multiformats and @ipld-dag-* have types and docs
  • Simpler story for users as there will only be one set of supported formats
  • Allows use of new ipld formats like dag-jose without shims
  • @ipld/dag-* modules are significantly smaller resulting in reduced bundle sizes
  • Reduces maintenance burden as ipld-dag-* modules can be retired in favour of @ipld/dag-*

Repo track list

Because this is a breaking change and we do not want to block the release of bug fixes or features in the interim, these PRs will be held as drafts until #3556 is green in CI as it pulls them all together, then all will be merged and released in quick succession.

Done = ✅
In Progress = 🚧
TODO = ⛔

Status Repo/PR Owner
js-ipfs #3556 @vmx/@achingbrain
dag-cbor-links -
ipfs/js-ipfs-bitswap#340 @achingbrain
ipfs/js-ipfs-repo#313 @achingbrain
ipfs/js-ipfs-repo-migrations#98 @achingbrain
ipfs/js-ipfs-unixfs#116 @vmx/@achingbrain
ipfs-shipyard/is-ipfs#42 @achingbrain
libp2p/js-libp2p-kad-dht#220 @achingbrain
libp2p/js-libp2p#948 @achingbrain
multiformats/js-multiaddr#200 @achingbrain
libp2p/js-peer-id#149 @achingbrain
libp2p/js-libp2p-interfaces#98 @achingbrain
libp2p/js-libp2p-delegated-peer-routing#46 @achingbrain
libp2p/js-libp2p-delegated-content-routing#52 @achingbrain
libp2p/js-libp2p-utils#18 @achingbrain

Other issues

Afterwards

Deprecate the following modules on npm and archive their repos:

@achingbrain achingbrain added need/triage Needs initial labeling and prioritization awesome endeavour exp/intermediate Prior experience is likely helpful status/in-progress In progress and removed need/triage Needs initial labeling and prioritization labels May 26, 2021
@achingbrain achingbrain pinned this issue May 26, 2021
@BigLep
Copy link
Contributor

BigLep commented May 26, 2021

Thanks @achingbrain for putting this together. I set you as the assignee and put it on the maintenance board.

A couple of questions:

  1. Will we be able to delete/archive some repos at the end of this? If so, can we make sure that is part of closing out this issue?
  2. Will items be marked ✅ when they are merged or ready for merge? I'm wondering if we need another state or states (e.g., "in reviewer's court", "ready for merge", "merged").

@achingbrain
Copy link
Member Author

  1. Yes, we should be able to archive a bunch of repos - I've added some to the OP off the top of my head
  2. Normally merged and released but I think here it would mean "Approved" so we can do the merges in one go when feat: upgrade to the new multiformats #3556 is green. Can add extra statuses if you think it'd be useful but in the past ⛔ 🚧 ✅ has been enough.

@achingbrain
Copy link
Member Author

Shipped in ipfs-core@0.9.0 and ipfs-http-client@51.0.0

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
awesome endeavour exp/intermediate Prior experience is likely helpful status/in-progress In progress
Projects
No open projects
Archived in project
Development

No branches or pull requests

2 participants