From aa8edae93b99da3d7e11eecd4f27d0a61652e0bc Mon Sep 17 00:00:00 2001 From: Gus Eggert Date: Thu, 30 Mar 2023 20:17:50 -0400 Subject: [PATCH] feat: add migration documentation to README --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index b12f71ccb..e1a0845a7 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ Boxo 🍌 - [Does Boxo == IPFS?](#does-boxo--ipfs) - [Is everything related to IPFS in the Go ecosystem in this repo?](#is-everything-related-to-ipfs-in-the-go-ecosystem-in-this-repo) - [Getting started](#getting-started) +- [Migrating to Boxo](#migrating-to-boxo) - [Should I add my IPFS component to Boxo?](#should-i-add-my-ipfs-component-to-boxo) - [Help](#help) - [Governance and Access](#governance-and-access) @@ -78,6 +79,22 @@ The code coverage of this repo is not currently representative of the actual tes ## Getting started See [examples](./examples/README.md). +If you are migrating to Boxo, see the Migrating section + +## Migrating to Boxo +Many Go modules under github.com/ipfs have moved here. Boxo provides a tool to ease this migration, which does most of the work for you: + +* `cd` into the root directory of your module (where the `go.mod` file is) +* Run: `go run github.com/ipfs/boxo/cmd/boxo-migrate@latest update-imports` + * This will upgrade your module to Boxo v0.8.0 and rewrite your import paths +* Run: `go run github.com/ipfs/boxo/cmd/boxo-migrate@latest check-dependencies` + * This will print unmaintained dependencies you still have + * These aren't necessarily an immediate problem, but you should eventually get them out of your dependency graph + +This tool only upgrades your module to Boxo v0.8.0, to minimize backwards-incompatible changes. Depending on the versions of IPFS modules before the upgrade, your code may require additional changes to build. + +If you encounter any challenges, please [open an issue](https://github.com/ipfs/boxo/issues/new/choose) and Boxo maintainers will help you. + ## Should I add my IPFS component to Boxo? We happily accept external contributions! However, Boxo maintains a high quality bar, so code accepted into Boxo must meet some minimum maintenance criteria: