deploy.yaml

name: Build and Deploy Docs to GitHub Pages

on:
  workflow_dispatch:
  push:
    paths:
      - '.github/workflows/deploy.yaml'
      - 'docs/**'
    # Review gh actions docs if you want to further define triggers, paths, etc
    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on


jobs:
  deploy:
    name: Build and Deploy to GitHub Pages
    runs-on: ubuntu-latest

    permissions:
      contents: write

    defaults:
      run:
        working-directory: docs

    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: yarn
          cache-dependency-path: docs/package.json

      - name: Install dependencies
        run: yarn install --frozen-lockfile
      - name: Build website
        run: yarn build
        env:
          DOCS_SEGMENT_API_KEY: ${{ secrets.DOCS_SEGMENT_API_KEY }}

      # Popular action to deploy to GitHub Pages:
      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
      - name: Deploy to GitHub Pages
        if: github.ref == 'refs/heads/master'
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          # Build output to publish to the `gh-pages` branch:
          publish_dir: docs/build