build-ghosttykit.yml

name: Build GhosttyKit

on:
  push:
    branches:
      - main
    paths:
      # Bare "ghostty" is required to match submodule POINTER bumps; the glob
      # only matches diffs inside the submodule tree (see ci.yml note).
      - "ghostty"
      - "ghostty/**"
      - ".gitmodules"
      - "scripts/ensure-ghosttykit.sh"
      - "scripts/required-zig-version.sh"
      - "scripts/download-prebuilt-ghosttykit.sh"
      - "scripts/install-zig.sh"
      - "scripts/zig-macos-aarch64.sha256"
      - ".github/workflows/build-ghosttykit.yml"
  pull_request:
    paths:
      # Bare "ghostty" is required to match submodule POINTER bumps; the glob
      # only matches diffs inside the submodule tree (see ci.yml note).
      - "ghostty"
      - "ghostty/**"
      - ".gitmodules"
      - "scripts/ensure-ghosttykit.sh"
      - "scripts/required-zig-version.sh"
      - "scripts/download-prebuilt-ghosttykit.sh"
      - "scripts/install-zig.sh"
      - "scripts/zig-macos-aarch64.sha256"
      - ".github/workflows/build-ghosttykit.yml"

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  build-ghosttykit:
    runs-on: macos-15
    timeout-minutes: 20
    steps:
      - name: Checkout
        uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
        with:
          submodules: recursive

      - name: Get ghostty SHA
        id: ghostty-sha
        run: |
          SHA=$(git -C ghostty rev-parse HEAD)
          echo "sha=$SHA" >> "$GITHUB_OUTPUT"
          echo "Ghostty SHA: $SHA"

      - name: Check if xcframework release already exists
        id: check-release
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          TAG="xcframework-${{ steps.ghostty-sha.outputs.sha }}"
          if gh release view "$TAG" --repo darkroomengineering/ghostty >/dev/null 2>&1; then
            echo "exists=true" >> "$GITHUB_OUTPUT"
            echo "Release $TAG already exists, skipping build"
          else
            echo "exists=false" >> "$GITHUB_OUTPUT"
            echo "Release $TAG not found, will build"
          fi

      - name: Select Xcode
        if: steps.check-release.outputs.exists == 'false'
        run: |
          set -euo pipefail
          if [ -d "/Applications/Xcode.app/Contents/Developer" ]; then
            XCODE_DIR="/Applications/Xcode.app/Contents/Developer"
          else
            XCODE_APP="$(ls -d /Applications/Xcode*.app 2>/dev/null | head -n 1 || true)"
            if [ -n "$XCODE_APP" ]; then
              XCODE_DIR="$XCODE_APP/Contents/Developer"
            else
              echo "No Xcode.app found under /Applications" >&2
              exit 1
            fi
          fi
          echo "DEVELOPER_DIR=$XCODE_DIR" >> "$GITHUB_ENV"
          export DEVELOPER_DIR="$XCODE_DIR"
          xcodebuild -version

      - name: Resolve zig version
        if: steps.check-release.outputs.exists == 'false'
        id: zig-version
        run: printf 'version=%s\n' "$(./scripts/required-zig-version.sh)" >> "$GITHUB_OUTPUT"

      # install-zig.sh re-checks the tarball against scripts/zig-macos-aarch64.sha256
      # on every run, so a cache hit never skips the checksum.
      - name: Cache zig toolchain tarball
        if: steps.check-release.outputs.exists == 'false'
        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4
        with:
          path: ~/.cache/programa-zig-dist
          key: zig-dist-macos-arm64-${{ steps.zig-version.outputs.version }}

      - name: Cache Zig packages
        if: steps.check-release.outputs.exists == 'false'
        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4
        with:
          path: ~/.cache/zig
          key: zig-packages-${{ hashFiles('ghostty/build.zig.zon', 'ghostty/build.zig.zon.json') }}
          restore-keys: zig-packages-

      - name: Build GhosttyKit.xcframework
        if: steps.check-release.outputs.exists == 'false'
        run: |
          set -euo pipefail
          ./scripts/install-zig.sh
          cd ghostty && zig build -Demit-xcframework=true -Demit-macos-app=false -Dxcframework-target=native -Doptimize=ReleaseFast

      - name: Package xcframework
        if: steps.check-release.outputs.exists == 'false'
        run: |
          set -euo pipefail
          rm -rf GhosttyKit.xcframework
          cp -R ghostty/macos/GhosttyKit.xcframework GhosttyKit.xcframework
          # Ghostty has used several archive names across revisions.
          ARCHIVE="$(find GhosttyKit.xcframework -type f \( -name 'libghostty.a' -o -name 'libghostty-fat.a' -o -name 'libghostty-internal.a' -o -name 'libghostty-internal-fat.a' \) -print -quit)"
          if [ -z "$ARCHIVE" ]; then
            echo "GhosttyKit.xcframework does not contain a supported macOS libghostty archive" >&2
            exit 1
          fi
          ./scripts/verify-release-architectures.sh "$ARCHIVE"
          tar czf GhosttyKit.xcframework.tar.gz GhosttyKit.xcframework

      - name: Upload xcframework release
        if: steps.check-release.outputs.exists == 'false'
        env:
          GH_TOKEN: ${{ secrets.GHOSTTY_RELEASE_TOKEN }}
        run: |
          set -euo pipefail
          if [ -z "${GH_TOKEN:-}" ]; then
            echo "GHOSTTY_RELEASE_TOKEN not available (fork PR), skipping upload"
            exit 0
          fi
          TAG="xcframework-${{ steps.ghostty-sha.outputs.sha }}"
          gh release create "$TAG" \
            --repo darkroomengineering/ghostty \
            --title "GhosttyKit xcframework (${{ steps.ghostty-sha.outputs.sha }})" \
            --notes "Pre-built GhosttyKit.xcframework for commit ${{ steps.ghostty-sha.outputs.sha }}" \
            GhosttyKit.xcframework.tar.gz
          echo "Published release $TAG"