Skip to content

V5 Docs - GitHub Action Changes #383

V5 Docs - GitHub Action Changes

V5 Docs - GitHub Action Changes #383

Workflow file for this run

name: CI
on:
push:
branches: [master]
pull_request:
permissions:
contents: read
jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: lts/*
cache: npm
- name: Install dependencies
run: npm ci
- name: Run Linter
run: npm run eslint
- name: Run Formatter
run: npm run prettier
test:
name: Test / ${{ matrix.node-version }}
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [latest, lts/*, lts/-1]
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js (${{ matrix.node-version }})
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: npm
- name: Install dependencies
run: npm ci
- name: Run tests
run: npm test
api:
name: API & Doc Validation
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: lts/*
cache: npm
- name: Install dependencies
run: npm ci
- name: Build
run: npm run build
- name: Extract API
run: npm run api:extract
- name: Generate docs
run: npm run api:docs
- name: Ensure API and doc changes have been committed
run: |
if (( "$(git status --porcelain=1 | wc -l)" != 0 )); then
cat << EOF >> $GITHUB_STEP_SUMMARY
### Uncommitted changes
\`\`\`shell
$(git diff-index HEAD)
\`\`\`
EOF
exit 1
fi