doc_ci.yml

name: Documentation CI

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - '**'
    paths:
      - 'website/**'
      - '.github/**'
      - '.yarn/**'
      - .yarnrc.yml
      - .npmignore
      - .gitignore

concurrency:
  group: doc-generator-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  checks:
    if: github.event_name != 'push'
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v4 # If you're using actions/checkout@v3 you must set persist-credentials to false in most cases for the deployment to work correctly.
        with:
          persist-credentials: false
          fetch-depth: 20
          fetch-tags: false

      - name: Restore cached node modules ♻️
        id: cache-yarn
        uses: actions/cache@v4
        with:
          path: |
            website/node_modules
            website/.yarn
          key: ${{ runner.os }}-build-doc-${{ hashFiles('**/yarn.lock') }}
          restore-keys: ${{ runner.os }}-build-doc

      - name: Install 🔧
        if: ${{ steps.cache-yarn.outputs.cache-hit != 'true' }}
        run: yarn
        working-directory: website

      - name: Build 🔨
        run: yarn build
        working-directory: website

  build-and-deploy:
    if: github.event_name != 'pull_request'
    runs-on: ubuntu-latest
    steps:
      - name: Checkout 🛎️
        uses: actions/checkout@v4 # If you're using actions/checkout@v3 you must set persist-credentials to false in most cases for the deployment to work correctly.
        with:
          persist-credentials: false
          fetch-depth: 20
          fetch-tags: false

      - name: Restore cached node modules ♻️
        id: cache-yarn
        uses: actions/cache@v4
        with:
          path: |
            website/node_modules
            website/.yarn
          key: ${{ runner.os }}-build-doc-${{ hashFiles('**/yarn.lock') }}
          restore-keys: ${{ runner.os }}-build-doc

      - name: Install 🔧
        if: ${{ steps.cache-yarn.outputs.cache-hit != 'true' }}
        run: yarn
        working-directory: website

      - name: Build 🔨
        run: yarn build
        working-directory: website

      - name: Deploy 🚀
        uses: JamesIves/github-pages-deploy-action@v4.6.4
        with:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          BRANCH: gh-pages # The branch the action should deploy to.
          FOLDER: website/build # The folder the action should deploy.
          CLEAN: true # Automatically remove deleted files from the deploy branch