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

docs: add missing upgrade guides #4240

Merged
merged 1 commit into from
Oct 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/upgrading/v0.62-v0.63.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!--Specify versions for migration below-->
# Migrating to [email protected] and [email protected] <!-- omit in toc -->

> A migration guide for refactoring your application code from `ipfs@0.63.x` to `ipfs@0.64.x`
> A migration guide for refactoring your application code from `ipfs@0.62.x` to `ipfs@0.63.x`

## Table of Contents <!-- omit in toc -->

- [ESM](#esm)
- [[email protected]](#libp2p037x)
- [`[email protected]`](#libp2p037x)
- [PeerIds](#peerids)
- [multiaddrs](#multiaddrs)

Expand Down
16 changes: 16 additions & 0 deletions docs/upgrading/v0.63-v0.64.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!--Specify versions for migration below-->
# Migrating to [email protected] and [email protected] <!-- omit in toc -->

> A migration guide for refactoring your application code from `[email protected]` to `[email protected]`

## Table of Contents <!-- omit in toc -->

- [libp2p](#libp2p)

## libp2p

The upgrade to `[email protected]` incorporates an update to `[email protected]` but no API changes.

If your application uses only the default libp2p config there is nothing to do.

If you supply a custom `libp2p` instance to the `ipfs` factory function you should consult the [`[email protected]` upgrade guide](https://github.com/libp2p/js-libp2p/blob/master/doc/migrations/v0.37-v0.38.md) for any changes you need to make.
23 changes: 23 additions & 0 deletions docs/upgrading/v0.64-v0.65.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--Specify versions for migration below-->
# Migrating to [email protected] and [email protected] <!-- omit in toc -->

> A migration guide for refactoring your application code from `[email protected]` to `[email protected]`

## Table of Contents <!-- omit in toc -->

- [libp2p](#libp2p)
- [multiformats](#multiformats)

## libp2p

The upgrade to `[email protected]` incorporates an update to `[email protected]` but no API changes.

If your application uses only the default libp2p config there is nothing to do.

If you supply a custom `libp2p` instance to the `ipfs` factory function you should consult the [`[email protected]` upgrade guide](https://github.com/libp2p/js-libp2p/blob/master/doc/migrations/v0.39-v0.40.md) for any changes you need to make.

## multiformats

`[email protected]` now uses `[email protected]`, this means instances of the `CID` class now come from that module and not `[email protected]` so any `instanceof` checks your codebase has may break if instances are compare to the class loaded from a different module version.

If your project also has a dependency on the `multiformats` module, it should be updated to `10.x.x` in line with js-ipfs.