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

Commit a77e40c

Browse files
authored
docs: add missing upgrade guides (#4240)
Add guides for the last few releases.
1 parent e8b7b66 commit a77e40c

File tree

3 files changed

+41
-2
lines changed

3 files changed

+41
-2
lines changed

docs/upgrading/v0.62-v0.63.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<!--Specify versions for migration below-->
22
# Migrating to [email protected] and [email protected] <!-- omit in toc -->
33

4-
> A migration guide for refactoring your application code from `ipfs@0.63.x` to `ipfs@0.64.x`
4+
> A migration guide for refactoring your application code from `ipfs@0.62.x` to `ipfs@0.63.x`
55
66
## Table of Contents <!-- omit in toc -->
77

88
- [ESM](#esm)
9-
- [[email protected]](#libp2p037x)
9+
- [`[email protected]`](#libp2p037x)
1010
- [PeerIds](#peerids)
1111
- [multiaddrs](#multiaddrs)
1212

docs/upgrading/v0.63-v0.64.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!--Specify versions for migration below-->
2+
# Migrating to [email protected] and [email protected] <!-- omit in toc -->
3+
4+
> A migration guide for refactoring your application code from `[email protected]` to `[email protected]`
5+
6+
## Table of Contents <!-- omit in toc -->
7+
8+
- [libp2p](#libp2p)
9+
10+
## libp2p
11+
12+
The upgrade to `[email protected]` incorporates an update to `[email protected]` but no API changes.
13+
14+
If your application uses only the default libp2p config there is nothing to do.
15+
16+
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.

docs/upgrading/v0.64-v0.65.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!--Specify versions for migration below-->
2+
# Migrating to [email protected] and [email protected] <!-- omit in toc -->
3+
4+
> A migration guide for refactoring your application code from `[email protected]` to `[email protected]`
5+
6+
## Table of Contents <!-- omit in toc -->
7+
8+
- [libp2p](#libp2p)
9+
- [multiformats](#multiformats)
10+
11+
## libp2p
12+
13+
The upgrade to `[email protected]` incorporates an update to `[email protected]` but no API changes.
14+
15+
If your application uses only the default libp2p config there is nothing to do.
16+
17+
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.
18+
19+
## multiformats
20+
21+
`[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.
22+
23+
If your project also has a dependency on the `multiformats` module, it should be updated to `10.x.x` in line with js-ipfs.

0 commit comments

Comments
 (0)