Examples description minor fix #12401
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: CI | |
on: | |
workflow_dispatch: | |
push: | |
branches: [ main ] | |
pull_request: | |
branches: [ main ] | |
concurrency: | |
group: ci-${{ github.event.pull_request.number || github.ref }} | |
cancel-in-progress: true | |
permissions: | |
contents: read | |
jobs: | |
build: | |
name: Build | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
- name: Setup Node.js 18.x | |
uses: actions/setup-node@v4 | |
with: | |
node-version: 18.x | |
cache: 'npm' | |
- name: Install dependencies | |
run: npm clean-install --progress=false --no-fund | |
- name: Build PlayCanvas | |
run: npm run build | |
- name: Run Publint | |
run: npm run publint | |
docs: | |
name: Docs | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
- name: Setup Node.js 18.x | |
uses: actions/setup-node@v4 | |
with: | |
node-version: 18.x | |
cache: 'npm' | |
- name: Install dependencies | |
run: npm clean-install --progress=false --no-fund | |
- name: Build API reference manual | |
run: npm run docs | |
lint: | |
name: Lint | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
- name: Setup Node.js 18.x | |
uses: actions/setup-node@v4 | |
with: | |
node-version: 18.x | |
cache: 'npm' | |
- name: Install dependencies | |
run: npm clean-install --progress=false --no-fund | |
- name: Run ESLint | |
run: npm run lint | |
- name: Run ESLint on examples | |
working-directory: ./examples | |
run: | | |
npm clean-install --progress=false --no-fund | |
npm run lint | |
typescript-declarations: | |
name: TypeScript Declarations | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
- name: Setup Node.js 18.x | |
uses: actions/setup-node@v4 | |
with: | |
node-version: 18.x | |
cache: 'npm' | |
- name: Install dependencies | |
run: npm clean-install --progress=false --no-fund | |
- name: Build TypeScript declarations | |
run: npm run build:types | |
- name: Compile TypeScript declarations | |
run: npm run test:types | |
unit-test-node: | |
name: Unit Test (Node) | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
- name: Setup Node.js 18.x | |
uses: actions/setup-node@v4 | |
with: | |
node-version: 18.x | |
cache: 'npm' | |
- name: Install dependencies | |
run: npm clean-install --progress=false --no-fund | |
- name: Run unit tests | |
run: npm test | |
unit-test-karma: | |
name: Unit Test (Karma) | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
- name: Setup Node.js 18.x | |
uses: actions/setup-node@v4 | |
with: | |
node-version: 18.x | |
cache: 'npm' | |
- name: Install dependencies | |
run: npm clean-install --progress=false --no-fund | |
- name: Build PlayCanvas (UMD-only) | |
run: npm run build:umd | |
- name: Install X virtual framebuffer | |
run: sudo apt-get install xvfb | |
- name: Run unit tests | |
run: xvfb-run --auto-servernum npm run test:karma | |
build-examples: | |
name: Build Examples Browser | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
- name: Setup Node.js 18.x | |
uses: actions/setup-node@v4 | |
with: | |
node-version: 18.x | |
cache: 'npm' | |
- name: Install dependencies | |
run: npm clean-install --progress=false --no-fund | |
- name: Build Examples Browser | |
working-directory: ./examples | |
run: | | |
npm clean-install --progress=false --no-fund | |
npm run build |