deploy.yml

name: Deploy to GitHub Pages

on:
  push:
    branches: [main]
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment.
concurrency:
  group: pages
  cancel-in-progress: true

jobs:
  deploy:
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: '22'
          cache: npm

      - name: Install dependencies
        run: npm ci

      - name: Download Surfer assets
        run: scripts/setup-surfer.sh

      - name: Download CIRCT wasm artifacts
        # Artifacts are stored in a GitHub Release named 'circt-wasm'.
        # To publish them locally, run:
        #   gh release create circt-wasm --title "CIRCT WASM artifacts" \
        #     public/circt/circt-{bmc,sim,verilog}.{js,wasm}
        # The build proceeds without them; simulation features will be
        # unavailable but the rest of the tutorial still works.
        run: |
          mkdir -p public/circt
          if gh release download circt-wasm \
               --repo "$GITHUB_REPOSITORY" \
               -D public/circt \
               --clobber 2>/dev/null; then
            echo "CIRCT artifacts downloaded from release 'circt-wasm'"
            ls -lh public/circt/
          else
            echo "::notice::No 'circt-wasm' release found; simulation features will be unavailable."
          fi
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Build
        run: npm run build
        env:
          VITE_BASE: /sv-tutorial/

      - uses: actions/upload-pages-artifact@v3
        with:
          path: dist

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