Skip to content

Update README.md

Update README.md #25

Workflow file for this run

name: Continuous Integration
on:
push:
branches:
- main
- master
workflow_dispatch:
jobs:
ci:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
name: ${{ matrix.os }}
permissions:
contents: read
id-token: write
defaults:
run:
shell: bash
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 18
- name: Install dependencies
run: npm install
- name: Formatting
run: npm run format:check
- name: Linting
run: npm run lint
# Once unit tests are working
#- name: Unit tests
# run: npm run test
- name: Build
run: npm run build
docs:
needs: ci
runs-on: ubuntu-latest
name: Docs build and deploy
permissions:
contents: write
id-token: write
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 18
- name: Install dependencies
run: npm install
- name: Build docs
run: npm run build:docs
- name: Deploy docs
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs
publish_branch: docs