github-pages.yml

name: Deploy site to GitHub Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

  # Allow triggering build from controller-firmware / sensor-firmware
  # and from espargos-one-manual (manual / CE declaration PDFs).
  repository_dispatch:
    types: [firmware-update, manual-update]

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

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

# Default to bash
defaults:
  run:
    shell: bash

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    env:
      HUGO_VERSION: 0.136.5
    steps:
      - name: Clone pyespargos repo
        uses: actions/checkout@v4
        with:
          ssh-key: ${{ secrets.PYESPARGOS_DEPLOY_KEY }}
          repository: ESPARGOS/pyespargos
          submodules: recursive
          path: pyespargos
      - name: Install sphinx and sphinx-rtd-theme
        run: sudo pip install sphinx sphinx-rtd-theme
      - name: Install pyespargos requirements
        run: cd pyespargos && pip install -r requirements.txt
      - name: Build sphinx docs
        run: make -C ./pyespargos/docs/ html

      - name: Checkout
        uses: actions/checkout@v4
        with:
          submodules: recursive
          path: espargos.github.io

      - name: Download firmware artifacts (dev + testing)
        env:
          CONTROLLER_FIRMWARE_TOKEN: ${{ secrets.CONTROLLER_FIRMWARE_TOKEN }}
          SENSOR_FIRMWARE_TOKEN: ${{ secrets.SENSOR_FIRMWARE_TOKEN }}
        run: |
          set -euo pipefail
          mkdir -p ./espargos.github.io/site/content/firmware/dev
          mkdir -p ./espargos.github.io/site/content/firmware/testing

          for repo in controller-firmware sensor-firmware; do
            if [[ "$repo" == "controller-firmware" ]]; then
              token="$CONTROLLER_FIRMWARE_TOKEN"
              artifact="controller-firmware-build-artifact"
            else
              token="$SENSOR_FIRMWARE_TOKEN"
              artifact="sensor-firmware-build-artifact"
            fi

            if [[ -z "${token}" ]]; then
              echo "Missing token for $repo. Set CONTROLLER_FIRMWARE_TOKEN / SENSOR_FIRMWARE_TOKEN secrets." >&2
              exit 1
            fi

            for branch in main testing; do
              echo "Finding artifacts for $repo, branch $branch"

              channel="dev"
              if [[ "$branch" == "testing" ]]; then
                channel="testing"
              fi

              run_id=$(GH_TOKEN="$token" gh api \
                repos/ESPARGOS/$repo/actions/workflows/build.yml/runs \
                -f branch="$branch" \
                -f status=completed \
                -f conclusion=success \
                -X GET \
                --jq '.workflow_runs[0].id')

              GH_TOKEN="$token" gh run download "$run_id" \
                -R ESPARGOS/$repo \
                -n "$artifact" \
                -D "./espargos.github.io/site/content/firmware/$channel"
            done
          done

      - name: Download manual artifacts
        env:
          MANUAL_TOKEN: ${{ secrets.MANUAL_TOKEN }}
        run: |
          set -euo pipefail

          if [[ -z "${MANUAL_TOKEN:-}" ]]; then
            echo "Missing MANUAL_TOKEN secret for ESPARGOS/espargos-one-manual." >&2
            exit 1
          fi

          mkdir -p ./espargos.github.io/site/content/espargos-one
          mkdir -p ./espargos.github.io/site/content/ce

          # Latest successful "Build manual" run on main produces the "pdfs"
          # artifact containing manual.pdf, ce-declaration.pdf, datasheet.pdf
          # and the aperture-kit configuration supplements.
          run_id=$(GH_TOKEN="$MANUAL_TOKEN" gh api \
            repos/ESPARGOS/espargos-one-manual/actions/workflows/build-manual.yml/runs \
            -f branch=main \
            -f status=completed \
            -f conclusion=success \
            -X GET \
            --jq '.workflow_runs[0].id')

          tmp="$(mktemp -d)"
          GH_TOKEN="$MANUAL_TOKEN" gh run download "$run_id" \
            -R ESPARGOS/espargos-one-manual \
            -n pdfs \
            -D "$tmp"

          cp "$tmp/manual.pdf"         ./espargos.github.io/site/content/espargos-one/espargos-one-manual.pdf
          cp "$tmp/datasheet.pdf"      ./espargos.github.io/site/content/espargos-one/espargos-one-datasheet.pdf
          cp "$tmp/ce-declaration.pdf" ./espargos.github.io/site/content/ce/espargos-one-ce-declaration.pdf
          cp "$tmp/aperture-kit/manual-6x4.pdf" ./espargos.github.io/site/content/espargos-one/espargos-one-aperture-kit-6x4-supplement.pdf
          cp "$tmp/aperture-kit/manual-8x4.pdf" ./espargos.github.io/site/content/espargos-one/espargos-one-aperture-kit-8x4-supplement.pdf

      - name: Install Hugo CLI
        run: |
          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
          && sudo dpkg -i ${{ runner.temp }}/hugo.deb
      - name: Install Dart Sass
        run: sudo snap install dart-sass
      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v5
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 20
      - name: Install Node.js dependencies
        run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
      - name: Build self-hosted esp-web-tools (patched esptool-js)
        working-directory: ./espargos.github.io/site
        run: bash ./scripts/build-esp-web-tools.sh
      - name: Build with Hugo
        working-directory: ./espargos.github.io/site
        env:
          # For maximum backward compatibility with Hugo modules
          HUGO_ENVIRONMENT: production
          HUGO_ENV: production
        run: |
          hugo \
            --minify \
            --baseURL "${{ steps.pages.outputs.base_url }}/"
      - name: Copy sphinx docs to hugo site
        run: cp -r pyespargos/docs/_build/html/* ./espargos.github.io/site/public/docs
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./espargos.github.io/site/public

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4