Add note for cli 5.0.0 modular breaking change (#538)

subquery · Jul 31, 2024 · c7108bf · c7108bf
1 parent a1676f2
commit c7108bf
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 2 deletions.
diff --git a/docs/indexer/build/introduction.md b/docs/indexer/build/introduction.md
@@ -67,6 +67,7 @@ You will then be prompted to select what `events` and/or `functions` that you wa
 ### For an Existing SubQuery Project
 
 You can also generate additional scaffolded code new contracts and append this code to your existing `project.ts`. This is done using the `subql codegen:generate` command from within your project workspace.
+If you have `@subql/cli` version `5.0.0` or above, you will need to install `@subql/common-ethereum` package in the dependencies before execute this command.
 
 ```shell
 subql codegen:generate \

diff --git a/docs/indexer/build/multi-chain.md b/docs/indexer/build/multi-chain.md
@@ -74,6 +74,7 @@ projects:
 ### 2. Generate Required Entities, Datasource Templates, and ABIs
 
 Use the `subql codegen` command to generate the required entities, datasource templates, and ABIs for all the projects listed in the multi-chain manifest file. By default, the codegen command will look for `subquery-multichain.yaml` if no multichain file is explicitly mentioned through `-f` flag
+If you have `@subql/cli` version `5.0.0` or above, you will need to install `@subql/common-ethereum` package in the dependencies before execute this command.
 
 ### 3. Add a New Network to the Multi-Chain Manifest
 

diff --git a/docs/indexer/quickstart/quickstart.md b/docs/indexer/quickstart/quickstart.md
@@ -144,7 +144,7 @@ The package.json file includes build scripts that allow you to build with either
 
 ```json
 "scripts": {
-    "build": "subql codegen && subql build", // default is production
+    "build": "subql codegen && subql build", // default is production, if you have `@subql/cli` version `5.0.0` or above, you will need to install `@subql/common-<network>` package in the dependencies before execute this command.
     "build:develop": "NODE_ENV=develop subql codegen && NODE_ENV=develop subql build"
 }
 ```

diff --git a/docs/indexer/run_publish/publish.md b/docs/indexer/run_publish/publish.md
@@ -44,6 +44,7 @@ If your project is still being deployed via GitHub, read the migration guide for
 ### How to publish a project
 
 Run the following command, which will read the project's default manifest `project.ts` for the required information.
+If you have `@subql/cli` version `5.0.0` or above, you will need to install `@subql/common-<network>` package in the dependencies before execute this command.
 
 ```
 // Publish it from your project's root directory
@@ -79,7 +80,9 @@ Uploading SupQuery project to IPFS
 SubQuery Project uploaded to IPFS: QmZ3q7YZSmhwBiot4PQCK3c7Z6HkteswN2Py58gkkZ8kNd  //CID
 ```
 
-Note: With `@subql/cli` version 1.3.0 or above, when using `subql publish`, a copy of the project's `IPFS CID` will be stored in a file in your project directory. The naming of the file will be consistent with your project.ts. For example, if your manifest file is named `project.ts`, the IPFS file will be named `.project-cid`.
+Note: 
+- With `@subql/cli` version 1.3.0 or above, when using `subql publish`, a copy of the project's `IPFS CID` will be stored in a file in your project directory. The naming of the file will be consistent with your project.ts. For example, if your manifest file is named `project.ts`, the IPFS file will be named `.project-cid`.
+- With `@subql/cli` version `5.0.0` or above, you will need to install `@subql/common-<network>` package in the dependencies before execute this command. For example, for substrate project, please make sure`@subql/common-substrate` 4.0.0 is installed
 
 ::: details What happens during IPFS Deployment?