docs.yml

name: Docs

# Events that trigger this workflow
on:
  push:
    branches: [main]

jobs:
  build-and-deploy:
    name: Build and deploy documentation
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 📥
        uses: actions/checkout@v3
      - name: Setup Node 💿
        uses: actions/setup-node@v3
        with:
          node-version: 14

      - name: Restore npm cache ♻️
        uses: actions/cache@v3
        with:
          path: ~/.npm
          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-node-

      # Remove, when setup-node action supports specifying the node version
      - name: Install npm v7 ⬆
        run: npm install --global npm@v7

      - name: Install development dependencies 📚
        run: npm ci
      - name: Build documentation 🛠️
        run: npm run docs:ci
      - name: Finalize build 🪄
        run: touch docs/.nojekyll

      - name: Deploy documentation 🚀
        uses: JamesIves/github-pages-deploy-action@v4.4.1
        with:
          branch: gh-pages
          folder: docs
          clean: true