chore: mergeback next -> identity-provider/2021-01-04

.github/workflows/nodejs-ci.yml

@@ -21,17 +21,14 @@ jobs:
       with:
         node-version: ${{ matrix.node }}
 
-    # See if we can lint before full build/test
-    - run: npm ci --ignore-scripts
-    - run: npm run lint --if-present
+    - run: npx lerna bootstrap
+    - run: npx lerna run lint
 
-    # full install, including npm postinstall, prepare
-    - run: npm ci
     # build monorepo incl. each subpackage
-    - run: npm run build --if-present
+    - run: npx lerna run build
 
     # test monorepo incl. each subpackage
-    - run: npm test
+    - run: npx lerna run test
       env:
         CI: true
 
@@ -99,7 +96,7 @@ jobs:
            &
         sleep 1
 
-    - run: npm run e2e
+    - run: npx lerna run e2e
       env:
         CI: true
         IC_REF_PORT: ${{ steps.ic_ref.outputs.IC_REF_PORT }}
@@ -109,7 +106,7 @@ jobs:
         CI: true
         IC_REF_PORT: 8888
         MITM: true
-      run: npm run mitm
+      run: npx lerna run mitm
 
     - name: clean up
       run: |

.gitignore

@@ -49,6 +49,7 @@ typings/
 # TypeScript cache
 *.tsbuildinfo
 build_info.json
+.tsc-out/
 
 # TypeScript output
 .tsc-out/
@@ -114,3 +115,4 @@ dist
 # IDE Settings
 .code
 .idea
+.vscode

README.md

@@ -9,10 +9,28 @@ This source code repository contains multiple npm packages, each under `./packag
 ### Getting Started
 
 1. Clone the git repository.
-2. Run `npm install`
+2. Run `npx lerna bootstrap`
 
 After that, you probably want to dive into a specific package in [./packages](./packages).
 
+#### Lerna
+
+We use [lerna](https://github.com/lerna/lerna) to manage this repo and its packages. A few useful
+commands to keep in mind;
+
+- To run the unit tests locally, you can use `npx lerna run test`.
+- To run e2e tests, you can use `npx lerna run e2e`. **WARNING:** You need to have a running
+  replica locally. In our CI runs, we use the `ic-ref` which is not (at this time) available
+  publicly. Normally you can use a replica distributed with dfx (ie. dfx start in a project),
+  but there is no guarantee that the `next` branch will work with the latest published dfx.
+  Once you have a replica running locally, you must pass the port to the e2e tests using the
+  `IC_REF_PORT` environment vairable. If that variable is not set, the tests will fail.
+- To run the entire ci, use `npx lerna run ci`. This will validate syntax and linting, as well
+  as running tests (both unit and e2e).
+
+You can also install lerna globally and not use `npx` if you wish; run `npm install -g lerna` then
+skip the `npx` part of the example commands.
+
 ### GitHub Actions
 
 GitHub Actions for this repo are configured in [./.github/workflows](./.github/workflows).