test.yml

name: Tests

on:
  pull_request:
    types: [opened, reopened, synchronize]
    branches:
      - dev
      - main
  push:
    branches:
      - dev
      - main
jobs:
  run-tests:
    name: All tests
    permissions:
      contents: read
      id-token: write
    runs-on: ubuntu-latest
    env:
      BROWSER: chrome
      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
    steps:
      - name: Check out Git repository
        uses: actions/checkout@v2
      - name: Setup Nodejs
        uses: actions/setup-node@v4
        with:
          node-version: 18.12.0
          cache: 'npm'
      - name: Install dependencies
        run: npm install
      - name: Build
        run: npm run build
      - name: All tests
        run: npm run test
      - name: Upload coverage
        uses: codecov/codecov-action@v4
        with:
          fail_ci_if_error: false
          token: ${{ secrets.CODECOV_TOKEN }}
  test-code-examples:
    name: Check typedocs
    permissions:
      contents: read
      id-token: write
    runs-on: ubuntu-latest
    steps:
      - name: Check out Git repository
        uses: actions/checkout@v2
      - name: Setup Nodejs
        uses: actions/setup-node@v4
        with:
          node-version: 18.12.0
          cache: 'npm'
      - name: Install dependencies
        run: npm install
      - name: Build Docs
        run: npm run build && npm run docs:json
      - name: tsdoc @example checks
        run: npm run test:examples
  test-html-examples:
    name: Run HTML Examples
    permissions:
      contents: read
      id-token: write
    runs-on: ubuntu-latest
    steps:
      - name: Check out Git repository
        uses: actions/checkout@v2
      - name: Setup Nodejs
        uses: actions/setup-node@v4
        with:
          node-version: 18.12.0
          cache: 'npm'
      - name: Install dependencies
        run: npm install
      - name: Build
        run: npm run build
      - name: Code example tests
        run: npm run test:html
  test-lint:
    name: Linting and environment checks
    permissions:
      contents: read
      id-token: write
    runs-on: ubuntu-latest
    steps:
      - name: Check out Git repository
        uses: actions/checkout@v2
      - name: Setup Nodejs
        uses: actions/setup-node@v4
        with:
          node-version: 18.12.0
          cache: 'npm'
      - name: Install dependencies
        run: npm install
      - name: Linting
        run: npm run lint
  test-readme:
    name: Ensure that examples in the README compile
    permissions:
      contents: read
      id-token: write
    runs-on: ubuntu-latest
    steps:
      - name: Check out Git repository
        uses: actions/checkout@v2
      - name: Setup Nodejs
        uses: actions/setup-node@v4
        with:
          node-version: 18.12.0
          cache: 'npm'
      - name: Install dependencies
        run: npm install
      - name: Build
        run: npm run build
      - name: Test
        run: npm run test:readme