sample-compile.yml

name: Sample compile

on:
  pull_request:
    paths:
      - 'cofhe/**/*.mdx'
      - 'cofhe/scripts/compile-samples.py'
      - '.github/workflows/sample-compile.yml'
  workflow_dispatch:

env:
  # The Solidity dependency versions the docs tell readers to install; see
  # cofhe/get-started/introduction/compatibility.mdx. cofhe/scripts/check-versions.py
  # --docs fails when these disagree with that page.
  COFHE_CONTRACTS_VERSION: 1.0.0
  CONFIDENTIAL_CONTRACTS_VERSION: 0.4.0
  # Pinned like Mint and Vale: forge ships often and its diagnostics change,
  # so an unpinned install turns unrelated pull requests red.
  FOUNDRY_VERSION: v1.5.1

jobs:
  solidity:
    name: compile Solidity samples
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0

      # Pages written before this check existed may carry broken samples, so
      # a pull request is judged only on the pages it touches. A manual run
      # checks the whole site to see the backlog.
      - name: Collect pages to check
        id: files
        run: |
          if [ "${{ github.event_name }}" = "pull_request" ]; then
            git diff --name-only --diff-filter=d \
              "origin/${{ github.base_ref }}...HEAD" -- 'cofhe/*.mdx' 'cofhe/**/*.mdx' > files.txt
          else
            git ls-files 'cofhe/*.mdx' 'cofhe/**/*.mdx' > files.txt
          fi
          count=$(wc -l < files.txt | tr -d ' ')
          echo "count=$count" >> "$GITHUB_OUTPUT"
          echo "Checking $count page(s):"
          cat files.txt

      - name: Set up Node.js
        if: steps.files.outputs.count != '0'
        uses: actions/setup-node@v4
        with:
          node-version: '20'

      # --no-save keeps the checkout clean: the repo has no package.json and
      # must not gain one. npm also pulls @openzeppelin/contracts, which
      # FHE.sol imports, and @openzeppelin/contracts-upgradeable, which the
      # confidential token contracts import. One install resolves a single
      # cofhe-contracts copy, which fhenix-confidential-contracts pins exactly.
      - name: Install Solidity packages
        if: steps.files.outputs.count != '0'
        run: |
          npm install --no-save \
            "@fhenixprotocol/cofhe-contracts@${COFHE_CONTRACTS_VERSION}" \
            "fhenix-confidential-contracts@${CONFIDENTIAL_CONTRACTS_VERSION}"

      - name: Install Foundry
        if: steps.files.outputs.count != '0'
        uses: foundry-rs/foundry-toolchain@v1
        with:
          version: ${{ env.FOUNDRY_VERSION }}

      # Extracts every ```solidity block from the changed pages and compiles
      # each one with forge. The script prints the page, the block number, and
      # the compiler error for every failure. TypeScript blocks are not
      # checked; this check is Solidity only.
      - name: Compile Solidity samples
        if: steps.files.outputs.count != '0'
        run: xargs -a files.txt python3 cofhe/scripts/compile-samples.py