docs.yml

name: Docs

# yamllint disable rule:truthy
on:
  push:
    branches:
      - main
    paths:
      - "docs/**"
  workflow_dispatch:
# yamllint enable rule:truthy

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  deploy:
    name: Deploy to GitHub Pages
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: 18
      - name: Get npm cache directory
        id: npm-cache-dir
        run: |
          echo "npm_cache_dir=$(npm config get cache)" >> "$GITHUB_ENV"
      - uses: actions/cache@v3
        id: npm-cache
        with:
          path: |
            ${{ env.npm_cache_dir }}
            docs/node_modules
          key: ${{ runner.os }}-node-${{ hashFiles('**/docs/package-lock.json') }}
          restore-keys: |
            ${{ runner.os }}-node-
      - name: Install dependencies
        run: npm ci
        if: steps.npm-cache.outputs.cache-hit != 'true'
        working-directory: docs
      - name: Build website
        run: npm run build
        working-directory: docs
      - name: Setup Pages
        uses: actions/configure-pages@v2
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: "./docs/build"
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v1