Skip to content

Update README.md (#1386) #3024

Update README.md (#1386)

Update README.md (#1386) #3024

Workflow file for this run

name: CI
on: [push, pull_request]
jobs:
lint:
name: Lint and format
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v4
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: "20.x"
- name: Update NPM
run: |
npm install -g npm@latest
- uses: actions/cache@v4
id: cache-modules
with:
path: "**/node_modules"
key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
- name: Install dependencies
if: steps.cache-modules.outputs.cache-hit != 'true'
run: |
npm run bootstrap
- name: Link packages
run: |
npm run link
- name: Lint and check format
run: |
npm run lint
npm run format
test-libs:
name: Libs - Build and test
runs-on: ubuntu-latest
timeout-minutes: 10
needs: lint
steps:
- uses: actions/checkout@v4
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: "20.x"
- name: Update NPM
run: |
npm install -g npm@latest
- uses: actions/cache@v4
id: cache-modules
with:
path: "**/node_modules"
key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
- name: Install dependencies
if: steps.cache-modules.outputs.cache-hit != 'true'
run: |
npm run bootstrap
- name: Link packages
run: |
npm run link
- name: Build and test
run: |
npm run build:libs
npm run test:libs
test-serverless:
name: Serverless - Build and test
runs-on: ubuntu-latest
timeout-minutes: 15
needs: [lint, test-libs]
steps:
- uses: actions/checkout@v4
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: "20.x"
- name: Update NPM
run: |
npm install -g npm@latest
- uses: actions/cache@v4
id: cache-modules
with:
path: "**/node_modules"
key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
- name: Install dependencies
if: steps.cache-modules.outputs.cache-hit != 'true'
run: |
npm run bootstrap
- name: Link packages
run: |
npm run link
- name: Build and test
run: |
npm run build:libs
npm run build:serverless
npm run test:serverless
test-cli:
name: CLI - Build and test
runs-on: ubuntu-latest
timeout-minutes: 15
needs: [lint, test-libs]
strategy:
matrix:
node: [18, 20]
steps:
- uses: actions/checkout@v4
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node }}
- name: Update NPM
run: |
npm install -g npm@latest
- uses: actions/cache@v4
id: cache-modules
with:
path: "**/node_modules"
key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
- name: Install dependencies
if: steps.cache-modules.outputs.cache-hit != 'true'
run: |
npm run bootstrap
- name: Link packages
run: |
npm run link
- name: Build and test
run: |
npm run build:libs
npm run build:cli
npm run test:cli
test-desktop-packaged-win:
name: Desktop packaged Windows - Build and test
runs-on: windows-latest
timeout-minutes: 60
needs: [lint, test-libs]
steps:
- uses: actions/checkout@v4
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: "20.x"
- name: Update NPM
run: |
npm install -g npm@latest
- uses: actions/cache@v4
id: cache-modules
with:
path: "**/node_modules"
key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
- name: Install dependencies
if: steps.cache-modules.outputs.cache-hit != 'true'
run: |
npm run bootstrap
- name: Link packages
run: |
npm run link
- name: Build
run: |
npm run build:libs
npm run build:desktop:ci
npm run package:desktop:test:win
- name: Run tests
run: |
npm run test:desktop:win
# test-desktop-packaged-mac:
# name: Desktop packaged MacOS - Build and test
# runs-on: macos-latest
# timeout-minutes: 120
# needs: [lint, test-libs]
# env:
# USE_HARD_LINKS: false
# steps:
# - uses: actions/checkout@v4
# - name: Install Node.js
# uses: actions/setup-node@v4
# with:
# node-version: "20.x"
# - name: Update NPM
# run: |
# npm install -g npm@latest
# - uses: actions/cache@v4
# id: cache-modules
# with:
# path: "**/node_modules"
# key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
# - name: Install dependencies
# if: steps.cache-modules.outputs.cache-hit != 'true'
# run: |
# npm run bootstrap
# - name: Link packages
# run: |
# npm run link
# - name: Build
# run: |
# npm run build:libs
# npm run build:desktop:ci
# npm run package:desktop:test:mac
# - name: Run tests
# run: |
# export DISPLAY=':99.0'
# Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
# npm run test:desktop:mac
test-desktop-packaged-linux:
name: Desktop packaged Linux - Build and test
runs-on: ubuntu-latest
timeout-minutes: 60
needs: [lint, test-libs]
env:
USE_HARD_LINKS: false
steps:
- uses: actions/checkout@v4
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: "20.x"
- name: Update NPM
run: |
npm install -g npm@latest
- uses: actions/cache@v4
id: cache-modules
with:
path: "**/node_modules"
key: ${{ runner.os }}-modules-${{ hashFiles('**/package-lock.json') }}
- name: Install dependencies
if: steps.cache-modules.outputs.cache-hit != 'true'
run: |
npm run bootstrap
- name: Link packages
run: |
npm run link
- name: Build
run: |
npm run build:libs
npm run build:desktop:ci
npm run package:desktop:test:linux
- name: Run tests
run: |
export DISPLAY=':99.0'
Xvfb :99 -screen 0 1024x768x24 > /dev/null 2>&1 &
npm run test:desktop:linux