Merge pull request #227 from ckb-devrel/v0.3.x

Merge V0.3.x into master

Author: RetricSu

.github/workflows/canary-publish.yml

@@ -14,18 +14,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'
 
       - name: Install dependencies
-        run: yarn
+        run: npm install -g pnpm && pnpm i
 
       - name: Build
-        run: yarn run build
+        run: pnpm build
 
       - name: Set up Git identity
         run: |

.github/workflows/node.js.yml

@@ -14,21 +14,21 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: "20"
 
       - name: Install dependencies
-        run: yarn
+        run: npm install -g pnpm && pnpm i
 
       - name: Linting
-        run: yarn run lint
+        run: pnpm lint
 
       - name: Building
-        run: yarn run build
+        run: pnpm build
 
-      - run: yarn run fmt
+      - run: pnpm fmt
       - run: git diff --exit-code

.github/workflows/publish.yml

@@ -11,18 +11,18 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'
 
       - name: Install dependencies
-        run: yarn
+        run: npm install -g pnpm && pnpm i 
 
       - name: Build
-        run: yarn run build
+        run: pnpm build
 
       # Setup .npmrc file to publish to npm
       - name: Publish to npm

README.md

@@ -54,6 +54,12 @@ There are BREAKING CHANGES between v0.2.x and v0.3.x, make sure to read the [mig
 npm install -g @offckb/cli
 ```
 
+or use `pnpm` to install:
+
+```sh
+pnpm install -g @offckb/cli
+```
+
 _We recommend using [LTS](https://nodejs.org/en/download/package-manager) version of Node to run `offckb`_
 
 ## Usage

docs/develop.md

@@ -23,3 +23,19 @@ All the script configs are generated by `ckb list-hashes` so you don't need to c
 ### Update templates
 
 edit the things in `templates/v${version}`
+
+### Install dependencies
+
+Since we use `pnpm` as a developing package manager, people install `offckb` by `npm` would require a [`npm-shrinkwrap.json`](https://docs.npmjs.com/cli/v8/commands/npm-shrinkwrap) file.
+
+When updating the dependencies, remember to run the following command to generate the `npm-shrinkwrap.json` file.
+
+```sh
+pnpm add <new-dependency>
+
+// run the following to keep npm-shrinkwrap consistent with out pnpm-lock.json
+
+npm shrinkwrap
+```
+
+Remember to run the above command when trying to publish a new version.