name: Deploy docs to Github Pages

on: 
  push:
    branches: 'main'

jobs:
  build_docs:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout the repository
        uses: actions/checkout@v4

      - name: Install Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 18
          cache: npm

      - name: Install dependencies
        run: npm install

      - name: Test to see if the project compiles
        run: npm run build

      - name: Run unit test
        run: npm run test

      - name: Create the docs directory locally in CI
        run: npm run docs

      - name: Upload Docs Artifact
        uses: actions/upload-artifact@v4
        with:
          name: docs
          path: 'docs/'

  deploy:
    needs: build_docs
    runs-on: ubuntu-latest

    permissions:
      pages: write
      id-token: write

    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    
    steps:
      - name: Checkout the repository
        uses: actions/checkout@v4

      - name: Download Docs Artifact
        uses: actions/download-artifact@v4
        with:
          name: docs
          path: 'docs/'

      - name: Upload to GitHub Pages
        uses: actions/upload-pages-artifact@v3
        with:
          path: 'docs/'

      - name: Deploy
        id: deployment
        uses: actions/deploy-pages@v4