Skip to content

Feature/motivate review #275

Feature/motivate review

Feature/motivate review #275

Workflow file for this run

name: Documentation
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
compile:
name: Compile
runs-on: ubuntu-latest
steps:
-
uses: actions/checkout@v3
-
name: Setup node
uses: actions/setup-node@v3
with:
node-version: '18.x'
-
name: Setup dependencies
run: npm install apidoc -g
-
name: Compile documentation
run: apidoc -i backend -o _site -c backend/apidoc.json
-
name: Cache documentation
if: ${{ github.ref == 'refs/heads/main' }}
uses: actions/cache/save@v3
with:
path: _site
key: docs-${{ github.sha }}
push:
name: Push to Pages
if: ${{ github.ref == 'refs/heads/main' }}
needs: [compile]
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
steps:
-
name: Fetch documentation cache
uses: actions/cache/restore@v3
with:
path: _site
key: docs-${{ github.sha }}
-
name: Upload GitHub Pages artifact
uses: actions/[email protected]
-
name: Deploy GitHub Pages
uses: actions/deploy-pages@v1