[Tracking issue] Release for the "over the hump" copy repo consolidation #202
Description
Done criteria
There is a Kubo release that has:
- All the repos listed below copied into this repo (with deprecated types signposts).
- A changelog following Document the release process #170
- No refactors applied on top.
In addition, the repos that are copied in have:
- Deprecated types
- Readme update with a signpost to Boxo
- Issues/PRs closed or copied
- Commit history maintained
List of repos and their status
The determination of this plan was handled in #174
| Repo | Destination | Copied? | Issues Hand Copied? | README notice of repo status added? | Deprecated Types? | Notes |
|---|---|---|---|---|---|---|
| ipfs/go-bitswap | boxo/bitswap | ✔️ | ✔️ Issues were transferred | ✔️ | ✔️ | This repo was fully migrated (not just copied). Archived. |
| ipfs/go-ipfs-files | boxo/files | ✔️ | ✔️ Issues were transferred | ✔️ | ✔️ | This repo was fully migrated (not just copied). Archived. |
| ipfs/go-ipfs-config | kubo/config | ✔️ | ✔️ Issues were transferred | ✔️ | ✔️ | This repo was fully migrated (not just copied). Archived. |
| ipfs/go-block-format | 🪜 Being moved of Boxo | n/a | ✔️ Issues moved back | ✔️ Reverted README notice | ✔️ Reverted | We are leaving this repo as it was pre-2023 as a separate repo from Boxo. |
| ipld/go-car | boxo/ipld/car | ✔️ | 🪜 Issues will not be copied since the repo is actively maintained by others. | 🪜 No readme notice will be added since the repo is actively maintained by others. | 🪜 No types will be deprecated. | Decisions here were made in #218, #218 (comment) |
| ipfs/go-merkledag | boxo/ipld/merkledag | ✔️ | 🪜 Issues will not be copied since the repo is maintained by others. | ✔️ No "not maintained" notice was added, but a pointer to Boxo was included. | 🪜 No types will be deprecated. | Decisions here were made in #218. The docs changes are in ipfs/go-merkledag#101 |
| ipfs/interface-go-ipfs-core | boxo/coreiface | ✔️ | ✔️ Issues were transferred to either boxo or kubo/client/rpc |
✔️ | ✔️ | we will keep non-kubo parts in boxo, and move kubo-specific parts to kubo repo. Archived. |
| ipfs/go-unixfs | boxo/ipld/unixfs | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-pinning-service-http-client | boxo/pinning/remote/client | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-path | boxo/path | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-namesys | boxo/namesys | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-mfs | boxo/mfs | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-ipfs-provider | boxo/provider | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-ipfs-pinner | boxo/pinning/pinner | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-ipfs-keystore | boxo/keystore | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-filestore | boxo/filestore | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-ipns | boxo/ipns | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-blockservice | boxo/blockservice | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-ipfs-chunker | boxo/chunker | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-fetcher | boxo/fetcher | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-ipfs-blockstore | boxo/blockstore | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-ipfs-posinfo | boxo/filestore/posinfo | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-ipfs-util | boxo/util | ✔️ | ✔️ | ✔️ | ✔️ | We don't want util dirs, but we'll refactor later. Archived. |
| ipfs/go-ipfs-ds-help | boxo/datastore/dshelp | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-verifcid | boxo/verifcid | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-ipfs-exchange-offline | boxo/exchange/offline | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-ipfs-routing | boxo/routing | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
| ipfs/go-ipfs-exchange-interface | boxo/exchange | ✔️ | ✔️ | ✔️ | ✔️ | Archived. |
- We want to make it easy for consumers to migrate, so we want to keep package names the same as much as possible, and import paths should be trivial to update. This takes priority over organized directory structures within libipfs, we will be refactoring later anyway. The focus here is on consolidation and making it easy to migrate.
- Anything that is only applicable to Kubo should go to Kubo, not go-libipfs
"not maintained" README messaging
This messaging will be posted in all the READMEs for repos that have been copied into Boxo that are not maintained any more: #202 (comment)