Skip to content

chore: Add docs

chore: Add docs #42

Workflow file for this run

name: CI
on:
push:
branches: [main]
pull_request:
branches: [main]
# https://pnpm.io/continuous-integration#github-actions
jobs:
biome:
if: "!contains(github.event.head_commit.message, 'skip-ci')"
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install pnpm
uses: pnpm/action-setup@v4
- name: Use Node.js
uses: actions/setup-node@v4
with:
cache: "pnpm"
node-version-file: ".node-version"
- name: Install dependencies
run: pnpm install
- name: Run CI
run: pnpm run ci
test:
if: "!contains(github.event.head_commit.message, 'skip-ci')"
strategy:
matrix:
os: [ubuntu-latest]
node-version: [18.x]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- name: Install pnpm
uses: pnpm/action-setup@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: "pnpm"
- name: Install dependencies
run: pnpm install
- name: Run Tests
run: pnpm test
types:
if: "!contains(github.event.head_commit.message, 'skip-ci')"
strategy:
matrix:
os: [ubuntu-latest]
node-version: [18.x]
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v4
- name: Install pnpm
uses: pnpm/action-setup@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: "pnpm"
- name: Install dependencies
run: pnpm install
- name: Types
run: pnpm types