Skip to content

docs: sprucing up docs, esp. reference doc generation #56

docs: sprucing up docs, esp. reference doc generation

docs: sprucing up docs, esp. reference doc generation #56

Workflow file for this run

name: Deploy to GitHub Pages
on:
pull_request:
branches:
- main
paths:
- 'docs/**'
push:
branches:
- main
paths:
- 'docs/**'
workflow_dispatch:
jobs:
build:
name: Build Docusaurus
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
cache-dependency-path: docs/package-lock.json
- name: Install dependencies
run: npm ci
working-directory: ./docs
- name: Install sub-package dependencies
run: |
for dir in packages/*
do
test -d "$dir" || continue
if [[ "$dir" == *"client" ]] || [[ "$dir" == *"events-api" ]] || [[ "$dir" == *"interactive-messages" ]]; then
continue
fi
pushd "$dir"
npm i
popd
done
- name: Lint docs
run: npm run lint
working-directory: ./docs
- name: Build website
run: npm run build
working-directory: ./docs
- name: Upload Build Artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/build
deploy:
name: Deploy to GitHub Pages
if: github.event_name != 'pull_request'
needs: build
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # verifies deployment is from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4