From e64813f6fdc681328da7cb893c93e1f4f70bfc99 Mon Sep 17 00:00:00 2001 From: Alex Potsides Date: Wed, 24 May 2023 19:19:57 +0100 Subject: [PATCH] docs: add deprecation notice to readmes (#4362) Adds a notice to every readme advising of deprecation and containing pointers to docs that help with the upgrade to Helia. --- packages/interface-ipfs-core/README.md | 6 ++++++ packages/interface-ipfs-core/package.json | 1 + packages/ipfs-cli/README.md | 6 ++++++ packages/ipfs-cli/src/commands/config/profile.js | 1 - packages/ipfs-client/README.md | 6 ++++++ packages/ipfs-core-config/README.md | 6 ++++++ packages/ipfs-core-types/README.md | 6 ++++++ packages/ipfs-core-utils/README.md | 6 ++++++ packages/ipfs-core/README.md | 6 ++++++ packages/ipfs-daemon/README.md | 6 ++++++ packages/ipfs-grpc-client/README.md | 6 ++++++ packages/ipfs-grpc-client/test/utils.spec.js | 2 ++ packages/ipfs-grpc-protocol/README.md | 6 ++++++ packages/ipfs-grpc-server/README.md | 6 ++++++ packages/ipfs-http-client/README.md | 8 +++++++- packages/ipfs-http-gateway/README.md | 6 ++++++ packages/ipfs-http-response/README.md | 6 ++++++ packages/ipfs-http-server/README.md | 6 ++++++ packages/ipfs-message-port-client/README.md | 6 ++++++ packages/ipfs-message-port-protocol/README.md | 6 ++++++ packages/ipfs-message-port-server/README.md | 6 ++++++ packages/ipfs/README.md | 6 ++++++ 22 files changed, 118 insertions(+), 2 deletions(-) diff --git a/packages/interface-ipfs-core/README.md b/packages/interface-ipfs-core/README.md index 1faa57c497..f7aefc208e 100644 --- a/packages/interface-ipfs-core/README.md +++ b/packages/interface-ipfs-core/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # interface-ipfs-core [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/interface-ipfs-core/package.json b/packages/interface-ipfs-core/package.json index 1fe11ae1ef..542a25d814 100644 --- a/packages/interface-ipfs-core/package.json +++ b/packages/interface-ipfs-core/package.json @@ -112,6 +112,7 @@ "pako": "^2.0.4", "readable-stream": "^4.0.0", "sinon": "^15.0.1", + "stream": "^0.0.2", "uint8arrays": "^4.0.2", "wherearewe": "^2.0.1" }, diff --git a/packages/ipfs-cli/README.md b/packages/ipfs-cli/README.md index 4445a75cc9..9af290b0df 100644 --- a/packages/ipfs-cli/README.md +++ b/packages/ipfs-cli/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-cli [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-cli/src/commands/config/profile.js b/packages/ipfs-cli/src/commands/config/profile.js index 328543bbbb..b619800c4e 100644 --- a/packages/ipfs-cli/src/commands/config/profile.js +++ b/packages/ipfs-cli/src/commands/config/profile.js @@ -12,7 +12,6 @@ const command = { builder (yargs) { return yargs - // @ts-expect-error types are wrong .command(commands) }, diff --git a/packages/ipfs-client/README.md b/packages/ipfs-client/README.md index cc76636339..52136d7f1c 100644 --- a/packages/ipfs-client/README.md +++ b/packages/ipfs-client/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-client [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-core-config/README.md b/packages/ipfs-core-config/README.md index 272cb0e329..124ca5f471 100644 --- a/packages/ipfs-core-config/README.md +++ b/packages/ipfs-core-config/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-core-config [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-core-types/README.md b/packages/ipfs-core-types/README.md index e2fb8e7c15..fd49d1d2b7 100644 --- a/packages/ipfs-core-types/README.md +++ b/packages/ipfs-core-types/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-core-types [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-core-utils/README.md b/packages/ipfs-core-utils/README.md index 0e8264bd03..25019782b2 100644 --- a/packages/ipfs-core-utils/README.md +++ b/packages/ipfs-core-utils/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-core-utils [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-core/README.md b/packages/ipfs-core/README.md index d617decaeb..b0752f4322 100644 --- a/packages/ipfs-core/README.md +++ b/packages/ipfs-core/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-core [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-daemon/README.md b/packages/ipfs-daemon/README.md index 4b33747691..6ab8fa47cb 100644 --- a/packages/ipfs-daemon/README.md +++ b/packages/ipfs-daemon/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-daemon [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-grpc-client/README.md b/packages/ipfs-grpc-client/README.md index 0912f358b4..0cbca9bb6f 100644 --- a/packages/ipfs-grpc-client/README.md +++ b/packages/ipfs-grpc-client/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-grpc-client [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-grpc-client/test/utils.spec.js b/packages/ipfs-grpc-client/test/utils.spec.js index e1a0190c8c..4a1fbe1ba3 100644 --- a/packages/ipfs-grpc-client/test/utils.spec.js +++ b/packages/ipfs-grpc-client/test/utils.spec.js @@ -11,6 +11,7 @@ describe('utils', () => { it('should transform a bidirectional client into an async iterable', async () => { const service = 'service' const options = { + host: '', metadata: { foo: 'bar' } @@ -42,6 +43,7 @@ describe('utils', () => { it('should propagate client errors', async () => { const service = 'service' const options = { + host: '', metadata: { foo: 'bar' } diff --git a/packages/ipfs-grpc-protocol/README.md b/packages/ipfs-grpc-protocol/README.md index 8713893aa0..11e1d31af1 100644 --- a/packages/ipfs-grpc-protocol/README.md +++ b/packages/ipfs-grpc-protocol/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-grpc-protocol [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-grpc-server/README.md b/packages/ipfs-grpc-server/README.md index 288c11a227..4d89fd8fe3 100644 --- a/packages/ipfs-grpc-server/README.md +++ b/packages/ipfs-grpc-server/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-grpc-server [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-http-client/README.md b/packages/ipfs-http-client/README.md index 36f7d1be01..3db4a1562e 100644 --- a/packages/ipfs-http-client/README.md +++ b/packages/ipfs-http-client/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-http-client [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) @@ -17,7 +23,7 @@ - [Getting Started](#getting-started) - [Next Steps](#next-steps) - [Usage](#usage) - - - [`create([options])`](#createoptions) + - [`create([options])`](#createoptions) - [Parameters](#parameters) - [Options](#options) - [Returns](#returns) diff --git a/packages/ipfs-http-gateway/README.md b/packages/ipfs-http-gateway/README.md index 0fc2789d88..61e78edf23 100644 --- a/packages/ipfs-http-gateway/README.md +++ b/packages/ipfs-http-gateway/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-http-gateway [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-http-response/README.md b/packages/ipfs-http-response/README.md index 37bb786279..0e7043a1cd 100644 --- a/packages/ipfs-http-response/README.md +++ b/packages/ipfs-http-response/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-http-response [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-http-server/README.md b/packages/ipfs-http-server/README.md index 5648531849..d18de39b02 100644 --- a/packages/ipfs-http-server/README.md +++ b/packages/ipfs-http-server/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-http-server [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-message-port-client/README.md b/packages/ipfs-message-port-client/README.md index 5f1b8283b4..48bdf46967 100644 --- a/packages/ipfs-message-port-client/README.md +++ b/packages/ipfs-message-port-client/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-message-port-client [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-message-port-protocol/README.md b/packages/ipfs-message-port-protocol/README.md index 6d1092e9f2..1c7d476004 100644 --- a/packages/ipfs-message-port-protocol/README.md +++ b/packages/ipfs-message-port-protocol/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-message-port-protocol [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs-message-port-server/README.md b/packages/ipfs-message-port-server/README.md index d0cfe08e33..ba88cce5a7 100644 --- a/packages/ipfs-message-port-server/README.md +++ b/packages/ipfs-message-port-server/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs-message-port-server [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech) diff --git a/packages/ipfs/README.md b/packages/ipfs/README.md index 1219fb338a..386fbc9d68 100644 --- a/packages/ipfs/README.md +++ b/packages/ipfs/README.md @@ -1,3 +1,9 @@ +> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia) +> +> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS) +> +> ⚠️ If you continue using this repo, please note that security fixes will not be provided + # ipfs [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)