diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c80bef0105..2b73057175 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -12,9 +12,12 @@ jobs: build_and_test: env: BUF_VERSION: '0.41.0' - runs-on: ubuntu-latest + strategy: + matrix: + node: [14] + os: [ubuntu-latest] + runs-on: ${{ matrix.os }} steps: - - name: Checkout code uses: actions/checkout@v2 with: @@ -32,12 +35,12 @@ jobs: path: | ./nim-waku/build/wakunode2 ./nim-waku/vendor/rln/target/debug - key: nim-waku-build-v3-${{ steps.nim-waku-head.outputs.ref }} + key: nim-waku-build-${{ matrix.os }}-v3-${{ steps.nim-waku-head.outputs.ref }} - name: Install NodeJS uses: actions/setup-node@v2 with: - node-version: '14' + node-version: ${{ matrix.node }} # This would have been done part of npm pretest but it gives better # visibility in the CI if done as a separate step @@ -70,7 +73,7 @@ jobs: uses: actions/cache@v2 with: path: ~/.npm - key: node-v1-${{ hashFiles('**/package-lock.json') }} + key: node-${{ matrix.os }}-${{ matrix.node }}-v1-${{ hashFiles('**/package-lock.json') }} - name: install using npm ci uses: bahmutov/npm-install@v1 diff --git a/README.md b/README.md index c76c48551d..25a4ce69c4 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,13 @@ For support, questions & more general topics, please join the discussion on the A node chat app is provided as a working example of the library. It is interoperable with the [nim-waku chat app example](https://github.com/status-im/nim-waku/blob/master/examples/v2/chat2.nim). -To run the chat app: +To run the chat app, first ensure you have [Node.js](https://nodejs.org/en/) v14 or above: + +```shell +node --version +``` + +Then, install and run: ```shell git clone https://github.com/status-im/js-waku/ ; cd js-waku @@ -46,7 +52,7 @@ npm install npm run chat -- --staticNode /ip4/134.209.139.210/tcp/30303/p2p/16Uiu2HAmPLe7Mzm8TsYUubgCAW1aJoeFScxrLj8ppHFivPo97bUZ ``` -You can also specify an optional `listenAddr` parameter (.e.g `--listenAddr /ip4/0.0.0.0/tcp/55123`). +You can also specify an optional `listenAddr` parameter (.e.g `--listenAddr /ip4/0.0.0.0/tcp/7777/ws`). This is only useful if you want a remote node to dial to your chat app, it is not necessary in normal usage when you just connect to the fleet. diff --git a/bors.toml b/bors.toml index 77e74df7fc..73e2fc807f 100644 --- a/bors.toml +++ b/bors.toml @@ -1,3 +1,6 @@ -status = ["build_and_test", "web_chat_build_and_test"] +status = [ + "build_and_test (14, ubuntu-latest)", + "web_chat_build_and_test" +] block_labels = ["work-in-progress"] delete_merged_branches = true