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 (manuals, datasheets, and CE declaration).
  repository_dispatch:
    types: [firmware-update, manual-update, sdr-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
          scratch="$(mktemp -d)"
          trap 'rm -rf "$scratch"' EXIT

          for repo in controller-firmware sensor-firmware; do
            if [[ "$repo" == "controller-firmware" ]]; then
              token="$CONTROLLER_FIRMWARE_TOKEN"
            else
              token="$SENSOR_FIRMWARE_TOKEN"
            fi
            if [[ -z "$token" ]]; then
              echo "Missing firmware token for $repo." >&2
              exit 1
            fi
            artifact="$repo-build-artifact"

            # Select uploads rather than run creation dates: a rerun can upload
            # fresh artifacts to a run created months earlier.
            artifacts=$(GH_TOKEN="$token" gh api "repos/ESPARGOS/$repo/actions/artifacts" \
              -X GET -f name="$artifact" -f per_page=100 --paginate --slurp)

            for branch in main testing; do
              channel=dev
              [[ "$branch" != testing ]] || channel=testing
              echo "Finding $artifact for $repo, branch $branch"
              candidates=$(jq -r --arg name "$artifact" --arg branch "$branch" '
                [.[].artifacts[] | select(.name == $name and .expired == false
                  and .workflow_run.head_branch == $branch)]
                | sort_by(.created_at, .id) | reverse[]
                | [.id, .workflow_run.id] | @tsv' <<< "$artifacts")
              artifact_id=""
              while IFS=$'\t' read -r candidate_id run_id; do
                [[ -n "$candidate_id" ]] || continue
                run=$(GH_TOKEN="$token" gh api "repos/ESPARGOS/$repo/actions/runs/$run_id")
                if jq -e --arg branch "$branch" '
                  .head_branch == $branch and .path == ".github/workflows/build.yml"
                  and .status == "completed" and .conclusion == "success"' <<< "$run" >/dev/null; then
                  artifact_id="$candidate_id"
                  echo "Downloading artifact $artifact_id from $repo run $run_id ($branch)"
                  break
                fi
              done <<< "$candidates"
              if [[ -z "$artifact_id" ]]; then
                echo "No matching artifact from a successful build.yml run for $repo/$branch." >&2
                jq -r --arg branch "$branch" '
                  .[].artifacts[] | select(.workflow_run.head_branch == $branch)
                  | "Artifact \(.id): \(.name), run \(.workflow_run.id), created \(.created_at), expired=\(.expired)"' <<< "$artifacts" >&2
                exit 1
              fi

              archive="$scratch/$repo-$branch.zip"
              GH_TOKEN="$token" gh api "repos/ESPARGOS/$repo/actions/artifacts/$artifact_id/zip" > "$archive"
              mkdir -p "./espargos.github.io/site/content/firmware/$channel"
              unzip -q -o "$archive" -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 the manuals, product and antenna datasheets,
          # CE declaration, and 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=success \
            -f per_page=1 \
            -X GET \
            --jq '.workflow_runs[0].id // empty')

          if [[ ! "$run_id" =~ ^[0-9]+$ ]]; then
            echo "No successful build-manual.yml run on main." >&2
            exit 1
          fi
          echo "Downloading pdfs from espargos-one-manual run $run_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/antenna-datasheet.pdf" ./espargos.github.io/site/content/espargos-one/espargos-one-antenna-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 recovery image catalog
        working-directory: ./espargos.github.io/site
        run: python3 ./scripts/build-recovery-catalog.py
      - 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: Include ESP-WebSDR and ESP-SDR firmware
        env:
          GH_TOKEN: ${{ github.token }}
        run: bash ./espargos.github.io/site/scripts/include-esp-sdr.sh ./espargos.github.io/site/public/espsdr/app
      - 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