swift_package_test.yml

name: Swift Matrix

permissions:
  contents: read

on:
  workflow_call:
    inputs:
      macos_xcode_versions:
        type: string
        description: "Xcode version list (JSON)"
        default: "[\"swift_6.1\", \"swift_6.2\", \"swift_6.3\", \"swift_6.4\"]"
      macos_exclude_xcode_versions:
        type: string
        description: "Exclude Xcode version list (JSON)"
        default: "[{\"xcode_version\": \"\"}]"
      macos_versions:
        type: string
        description: "macOS version list (JSON)"
        default: "[\"tahoe\"]"
      macos_archs:
        type: string
        description: "macOS arch list (JSON)"
        default: "[\"ARM64\"]"
      macos_swiftly_toolchains:
        type: string
        description: "List of macOS Swiftly toolchain builds to test, each pairing an Xcode version with a Swiftly-managed Swift toolchain (JSON list of objects with xcode_version, swift_version, os_version, arch)"
        default: "[{\"xcode_version\": \"swift_6.3\", \"swift_version\": \"main-snapshot\", \"os_version\": \"tahoe\", \"arch\": \"ARM64\"}]"
      ios_host_xcode_versions:
        type: string
        description: "Xcode version list (JSON)"
        default: null
      ios_host_exclude_xcode_versions:
        type: string
        description: "Exclude Xcode version list (JSON)"
        default: null
      ios_host_versions:
        type: string
        description: "iOS host (macOS) version list (JSON)"
        default: null
      ios_host_archs:
        type: string
        description: "iOS host (macOS) arch list (JSON)"
        default: null
      linux_swift_versions:
        type: string
        description: "Include Linux Swift version list (JSON)"
        default: "[ \"6.1\", \"6.2\", \"6.3\", \"6.4\", \"nightly-main\", \"nightly-6.4.x\"]"
      linux_exclude_swift_versions:
        type: string
        description: "Exclude Linux Swift version list (JSON)"
        default: "[{\"swift_version\": \"\"}]"
      linux_os_versions:
        type: string
        description: "Linux OS version list (JSON)"
        default: "[\"jammy\"]"
      linux_host_archs:
        type: string
        description: "Linux arch list (JSON)"
        default: "[\"x86_64\"]"
      linux_static_sdk_versions:
        type: string
        description: "Static Linux Swift SDK version list (JSON)"
        default: "[\"nightly-main\", \"nightly-6.4.x\", \"6.4\"]"
      linux_static_sdk_exclude_swift_versions:
        type: string
        description: "Exclude Static Linux Swift SDK version list (JSON)"
        default: "[{\"swift_version\": \"\"}]"
      wasm_sdk_versions:
        type: string
        description: "Wasm Swift SDK version list (JSON)"
        default: "[\"nightly-main\", \"nightly-6.4.x\", \"6.4\"]"
      wasm_exclude_swift_versions:
        type: string
        description: "Exclude Wasm Swift SDK version list (JSON)"
        default: "[{\"swift_version\": \"\"}]"
      android_sdk_versions:
        type: string
        description: "Android Swift SDK version list (JSON)"
        default: "[\"nightly-main\", \"nightly-6.4.x\", \"6.4\"]"
      android_exclude_swift_versions:
        type: string
        description: "Exclude Android Swift SDK version list (JSON)"
        default: "[{\"swift_version\": \"\"}]"
      windows_swift_versions:
        type: string
        description: "Include Windows Swift version list (JSON)"
        # "5.10" is omitted for Windows because the container image is broken.
        default: "[\"6.1\", \"6.2\", \"6.3\", \"6.4\", \"nightly-main\", \"nightly-6.4.x\"]"
      windows_exclude_swift_versions:
        type: string
        description: "Exclude Windows Swift version list (JSON)"
        default: "[{\"swift_version\": \"\"}]"
      windows_os_versions:
        type: string
        description: "Windows OS version label list (JSON)"
        default: "[\"windows-2022\"]"
      freebsd_swift_versions:
        type: string
        description: "FreeBSD Swift version list (JSON)"
        default: "[\"nightly-main\"]"
      freebsd_exclude_swift_versions:
        type: string
        description: "Exclude FreeBSD Swift version list (JSON)"
        default: "[{\"swift_version\": \"\"}]"
      freebsd_os_versions:
        type: string
        description: "FreeBSD OS version list (JSON)"
        default: "[\"14.3\"]"
      freebsd_host_archs:
        type: string
        description: "FreeBSD host arch list (JSON)"
        default: "[\"x86_64\"]"
      swift_flags:
        type: string
        description: "Swift flags for release version"
        default: ""
      swift_nightly_flags:
        type: string
        description: "Swift flags for nightly version"
        default: ""
      linux_pre_build_command:
        type: string
        description: "Linux command to execute before building the Swift package"
        default: ""
      linux_static_sdk_pre_build_command:
        type: string
        description: "Linux command to execute before building the Swift package with the Static Linux Swift SDK"
        default: ""
      wasm_sdk_pre_build_command:
        type: string
        description: "Linux command to execute before building the Swift package with the Embedded Swift SDK for Wasm"
        default: ""
      android_sdk_pre_build_command:
        type: string
        description: "Linux command to execute before building the Swift package with the Embedded Swift SDK for Android"
        default: ""
      macos_pre_build_command:
        type: string
        description: "macOS command to execute before building the Swift package"
        default: ""
      macos_build_command:
        type: string
        description: "macOS command to build and test the package"
        default: "xcrun swift test"
      macos_swiftly_build_command:
        type: string
        description: "macOS command to build and test the package when using a Swiftly-managed toolchain (run via `swiftly run`, so it should not use `xcrun`)"
        default: "swiftly run swift test"
      macos_build_timeout:
        type: number
        description: "The default step timeout in minutes"
        default: 60
      ios_pre_build_command:
        type: string
        description: "macOS command to execute before building the Swift package for iOS"
        default: ""
      ios_build_command:
        type: string
        description: "macOS command to build the package for iOS"
        default: "\"$(xcrun -f swift)\" build --build-tests --sdk \"$(xcrun --sdk iphoneos --show-sdk-path)\" --triple arm64-apple-ios"
      ios_build_timeout:
        type: number
        description: "The default step timeout in minutes"
        default: 60
      linux_build_command:
        type: string
        description: "Linux command to build and test the package"
        default: "swift test"
      linux_build_timeout:
        type: number
        description: "The default step timeout in minutes"
        default: 90
      linux_static_sdk_build_command:
        type: string
        description: "Command to use when building the package with the Static Linux Swift SDK"
        default: "swift build"
      linux_static_sdk_build_timeout:
        type: number
        description: "The default step timeout in minutes"
        default: 90
      wasm_sdk_build_command:
        type: string
        description: "Command to use when building the package with the Swift SDK for Wasm"
        default: "swift build"
      embedded_wasm_sdk_build_command:
        type: string
        description: "Command to use when building the package with the Embedded Swift SDK for Wasm"
        default: "swift build"
      wasm_sdk_build_timeout:
        type: number
        description: "The default step timeout in minutes"
        default: 90
      android_sdk_build_command:
        type: string
        description: "Command to use when building the package with the Swift SDK for Android"
        default: "swift build"
      android_sdk_build_timeout:
        type: number
        description: "The default step timeout in minutes"
        default: 90
      android_sdk_triples:
        type: string
        description: "The triples to use when building with the Swift SDK for Android. The final triple in the list will be used for the emulator testing and should match the host architecture."
        default: "[\"aarch64-unknown-linux-android28\", \"x86_64-unknown-linux-android28\"]"
      android_ndk_versions:
        type: string
        description: "The NDK versions to use when building with the Swift SDK for Android"
        default: "[\"r30\"]"
      windows_pre_build_command:
        type: string
        description: "Windows Command Prompt command to execute before building the Swift package"
        default: ""
      windows_build_command:
        type: string
        description: |
          Windows Command Prompt command to build and test the package.
          Note that Powershell does not automatically exit if a subcommand fails. The Invoke-Program utility is available to propagate non-zero exit codes.
          It is strongly encouraged to run all command using `Invoke-Program` unless you want to continue on error eg. `Invoke-Program git apply patch.diff` instead of `git apply patch.diff`.
        default: "Invoke-Program swift test"
      windows_build_timeout:
        type: number
        description: "The default step timeout in minutes"
        default: 60
      freebsd_pre_build_command:
        type: string
        description: "FreeBSD command to execute before building the Swift package"
        default: ""
      freebsd_build_command:
        type: string
        description: "FreeBSD command to build and test the package"
        default: "swift test"
      macos_env_vars:
        description: "Newline separated list of environment variables"
        type: string
      ios_host_env_vars:
        description: "Newline separated list of environment variables"
        type: string
      linux_env_vars:
        description: "Newline separated list of environment variables"
        type: string
      windows_env_vars:
        description: "Newline separated list of environment variables"
        type: string
      freebsd_env_vars:
        description: "Newline separated list of environment variables"
        type: string
      enable_linux_checks:
        type: boolean
        description: "Boolean to enable linux testing. Defaults to true"
        default: true
      enable_linux_static_sdk_build:
        type: boolean
        description: "Boolean to enable building with the Static Linux Swift SDK. Defaults to false"
        default: false
      enable_wasm_sdk_build:
        type: boolean
        description: "Boolean to enable building with the Swift SDK for Wasm. Defaults to false"
        default: false
      enable_embedded_wasm_sdk_build:
        type: boolean
        description: "Boolean to enable building with the Embedded Swift SDK for Wasm. Defaults to false"
        default: false
      enable_android_sdk_build:
        type: boolean
        description: "Boolean to enable building with the Swift SDK for Android. Defaults to false"
        default: false
      enable_android_sdk_checks:
        type: boolean
        description: "Boolean to enable testing with the Swift SDK for Android. Defaults to false"
        default: false
      enable_macos_checks:
        type: boolean
        description: "Boolean to enable macOS testing. Defaults to false"
        default: false
      enable_macos_swiftly_checks:
        type: boolean
        description: "Boolean to enable macOS testing with Swiftly-managed toolchains (e.g. nightly snapshots). Defaults to false"
        default: false
      enable_ios_checks:
        type: boolean
        description: "Boolean to enable iOS testing. Defaults to false"
        default: false
      enable_windows_checks:
        type: boolean
        description: "Boolean to enable windows testing. Defaults to true"
        default: true
      enable_windows_docker:
        type: boolean
        description: "Boolean to enable running build in windows docker container. Defaults to true"
        default: true
      enable_freebsd_checks:
        type: boolean
        description: "Boolean to enable FreeBSD testing. Defaults to false"
        default: false
      needs_token:
        type: boolean
        description: "Boolean to enable providing the GITHUB_TOKEN to downstream job."
        default: false
      enable_cross_pr_testing:
        type: boolean
        description: "Whether PRs can be tested in combination with other PRs by mentioning them as `Linked PR: <link to PR>` in the PR description"
        default: false

jobs:
  macos-build:
    name: macOS (Xcode ${{ matrix.xcode_version }} - ${{ matrix.os_version }} - ${{ matrix.arch }})
    if: ${{ inputs.enable_macos_checks }}
    runs-on: [self-hosted, macos, "${{ matrix.os_version }}", "${{ matrix.arch }}"]
    strategy:
      fail-fast: false
      matrix:
        xcode_version: ${{ fromJson(inputs.macos_xcode_versions) }}
        os_version: ${{ fromJson(inputs.macos_versions) }}
        arch: ${{ fromJson(inputs.macos_archs) }}
        exclude:
          - ${{ fromJson(inputs.macos_exclude_xcode_versions) }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v7
      - name: Provide token
        if: ${{ inputs.needs_token }}
        run: |
            echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" >> $GITHUB_ENV
      - name: Set environment variables
        if: ${{ inputs.macos_env_vars }}
        env:
          ENV_VARS: ${{ inputs.macos_env_vars }}
        run: |
            for i in "${ENV_VARS}"
            do
              printf "%s\n" $i >> $GITHUB_ENV
            done
      - name: Select Xcode
        run: echo "DEVELOPER_DIR=/Applications/Xcode_${{ matrix.xcode_version }}.app/Contents/Developer" >> $GITHUB_ENV
      - name: Swift version
        run: xcrun swift --version
      - name: Clang version
        run: xcrun clang --version
      - name: Pre-build
        # zizmor: ignore[template-injection]
        run: ${{ inputs.macos_pre_build_command }}
      - name: Build / Test
        # zizmor: ignore[template-injection]
        run: ${{ inputs.macos_build_command }} ${{ (contains(matrix.swift_version, 'nightly') && inputs.swift_nightly_flags) || inputs.swift_flags }}
        timeout-minutes: ${{ inputs.macos_build_timeout }}

  macos-swiftly-build:
    name: macOS via Swiftly (Xcode ${{ matrix.xcode_version }} + ${{ matrix.swift_version }} - ${{ matrix.os_version }} - ${{ matrix.arch }})
    if: ${{ inputs.enable_macos_swiftly_checks }}
    runs-on: [self-hosted, macos, "${{ matrix.os_version }}", "${{ matrix.arch }}"]
    strategy:
      fail-fast: false
      matrix:
        include: ${{ fromJson(inputs.macos_swiftly_toolchains) }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v7
      - name: Provide token
        if: ${{ inputs.needs_token }}
        run: |
            echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" >> $GITHUB_ENV
      - name: Set environment variables
        if: ${{ inputs.macos_env_vars }}
        env:
          ENV_VARS: ${{ inputs.macos_env_vars }}
        run: |
            for i in "${ENV_VARS}"
            do
              printf "%s\n" $i >> $GITHUB_ENV
            done
      - name: Select Xcode
        run: echo "DEVELOPER_DIR=/Applications/Xcode_${{ matrix.xcode_version }}.app/Contents/Developer" >> $GITHUB_ENV
      - name: Set up Swiftly environment
        run: |
          . "$HOME/.swiftly/env.sh"
          echo "SWIFTLY_HOME_DIR=$SWIFTLY_HOME_DIR" >> $GITHUB_ENV
          echo "SWIFTLY_BIN_DIR=$SWIFTLY_BIN_DIR" >> $GITHUB_ENV
          echo "SWIFTLY_TOOLCHAINS_DIR=$SWIFTLY_TOOLCHAINS_DIR" >> $GITHUB_ENV
          echo "$SWIFTLY_BIN_DIR" >> $GITHUB_PATH
      - name: Install Swift toolchain via Swiftly
        run: |
          swiftly install ${{ matrix.swift_version }}
          swiftly use ${{ matrix.swift_version }}
      - name: Swift version
        run: swiftly run swift --version
      - name: Pre-build
        # zizmor: ignore[template-injection]
        run: ${{ inputs.macos_pre_build_command }}
      - name: Build / Test
        # zizmor: ignore[template-injection]
        run: ${{ inputs.macos_swiftly_build_command }} ${{ (contains(matrix.swift_version, 'snapshot') && inputs.swift_nightly_flags) || inputs.swift_flags }}
        timeout-minutes: ${{ inputs.macos_build_timeout }}

  ios-build:
    name: iOS (Build Only, Xcode ${{ matrix.xcode_version }} - ${{ matrix.os_version }} - ${{ matrix.arch }})
    if: ${{ inputs.enable_ios_checks }}
    runs-on: [self-hosted, macos, "${{ matrix.os_version }}", "${{ matrix.arch }}"]
    strategy:
      fail-fast: false
      matrix:
        xcode_version: ${{ fromJson(inputs.ios_host_xcode_versions || inputs.macos_xcode_versions) }}
        os_version: ${{ fromJson(inputs.ios_host_versions || inputs.macos_versions) }}
        arch: ${{ fromJson(inputs.ios_host_archs || inputs.macos_archs) }}
        exclude:
          - ${{ fromJson(inputs.ios_host_exclude_xcode_versions || inputs.macos_exclude_xcode_versions) }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v7
      - name: Provide token
        if: ${{ inputs.needs_token }}
        run: |
            echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" >> $GITHUB_ENV
      - name: Set environment variables
        if: ${{ inputs.ios_host_env_vars }}
        env:
          ENV_VARS: ${{ inputs.ios_host_env_vars }}
        run: |
            for i in "${ENV_VARS}"
            do
              printf "%s\n" $i >> $GITHUB_ENV
            done
      - name: Select Xcode
        run: echo "DEVELOPER_DIR=/Applications/Xcode_${{ matrix.xcode_version }}.app/Contents/Developer" >> $GITHUB_ENV
      - name: Swift version
        run: |
          "$(xcrun -f swift)" --version
      - name: Pre-build
        # zizmor: ignore[template-injection]
        run: ${{ inputs.ios_pre_build_command }}
      - name: Build
        # zizmor: ignore[template-injection]
        run: ${{ inputs.ios_build_command }} ${{ (contains(matrix.swift_version, 'nightly') && inputs.swift_nightly_flags) || inputs.swift_flags }}
        timeout-minutes: ${{ inputs.ios_build_timeout }}

  linux-build:
    name: Linux (${{ matrix.swift_version }} - ${{ matrix.os_version }} - ${{ matrix.arch }})
    if: ${{ inputs.enable_linux_checks }}
    runs-on: ${{ matrix.runner }}
    strategy:
      fail-fast: false
      matrix:
        swift_version: ${{ fromJson(inputs.linux_swift_versions) }}
        os_version: ${{ fromJson(inputs.linux_os_versions) }}
        arch: ${{ fromJson(inputs.linux_host_archs) }}
        runner: ${{
            fromJson(
              contains(fromJson(inputs.linux_host_archs), 'x86_64') && !contains(fromJson(inputs.linux_host_archs), 'aarch64')
                && '["ubuntu-24.04"]'
                || contains(fromJson(inputs.linux_host_archs), 'aarch64') && !contains(fromJson(inputs.linux_host_archs), 'x86_64')
                && '["ubuntu-24.04-arm"]'
                || '["ubuntu-24.04","ubuntu-24.04-arm"]'
            )
          }}
        exclude:
          - ${{ fromJson(inputs.linux_exclude_swift_versions) }}
          - arch: x86_64
            runner: ubuntu-24.04-arm
          - arch: aarch64
            runner: ubuntu-24.04
    container:
      image: ${{ (contains(matrix.swift_version, 'nightly') && 'swiftlang/swift') || 'swift' }}:${{ matrix.swift_version }}-${{ matrix.os_version }}
    steps:
      - name: Swift version
        run: swift --version
      - name: Clang version
        run: clang --version
      - name: Checkout repository
        uses: actions/checkout@v7
        if: ${{ matrix.os_version != 'amazonlinux2' }}
      - name: Checkout repository
        uses: actions/checkout@v1
        if: ${{ matrix.os_version == 'amazonlinux2' }}
      - name: Checkout swiftlang/github-workflows repository
        if: ${{ matrix.os_version != 'amazonlinux2' && github.repository != 'swiftlang/github-workflows' }}
        uses: actions/checkout@v7
        with:
          repository: swiftlang/github-workflows
          path: github-workflows
      - name: Checkout swiftlang/github-workflows repository
        if: ${{ matrix.os_version == 'amazonlinux2' && github.repository != 'swiftlang/github-workflows' }}
        uses: actions/checkout@v1
        with:
          repository: swiftlang/github-workflows
          path: ${{ github.event.repository.name }}/github-workflows
          ref: main
      - name: Determine script-root path
        id: script_path
        run: |
          if [ "${{ github.repository }}" = "swiftlang/github-workflows" ]; then
            echo "root=$GITHUB_WORKSPACE" >> $GITHUB_OUTPUT
          else
            echo "root=$GITHUB_WORKSPACE/github-workflows" >> $GITHUB_OUTPUT
          fi
      - name: Provide token
        if: ${{ inputs.needs_token }}
        run: |
            echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" >> $GITHUB_ENV
      - name: Check out related PRs
        if: ${{ inputs.enable_cross_pr_testing && github.event_name == 'pull_request' }}
        run: |
          cat ${{ steps.script_path.outputs.root }}/.github/workflows/scripts/cross-pr-checkout.swift > /tmp/cross-pr-checkout.swift
          swift /tmp/cross-pr-checkout.swift "${{ github.repository }}" "${{ github.event.number }}"
      - name: Set environment variables
        if: ${{ inputs.linux_env_vars }}
        env:
          ENV_VARS: ${{ inputs.linux_env_vars }}
        run: |
            for i in "${ENV_VARS}"
            do
              printf "%s\n" $i >> $GITHUB_ENV
            done
      - name: Pre-build
        # zizmor: ignore[template-injection]
        run: ${{ inputs.linux_pre_build_command }}
      - name: Build / Test
        timeout-minutes: ${{ inputs.linux_build_timeout }}
        # zizmor: ignore[template-injection]
        run: ${{ inputs.linux_build_command }} ${{ (contains(matrix.swift_version, 'nightly') && inputs.swift_nightly_flags) || inputs.swift_flags }}

  linux-static-sdk-build:
    name: Static Linux Swift SDK Build (${{ matrix.swift_version }} - ${{ matrix.os_version }} - ${{ matrix.arch }})
    if: ${{ inputs.enable_linux_static_sdk_build }}
    runs-on: ${{ matrix.runner }}
    strategy:
      fail-fast: false
      matrix:
        swift_version: ${{ fromJson(inputs.linux_static_sdk_versions) }}
        os_version: ${{ fromJson(inputs.linux_os_versions) }}
        arch: ${{ fromJson(inputs.linux_host_archs) }}
        runner: ${{
            fromJson(
              contains(fromJson(inputs.linux_host_archs), 'x86_64') && !contains(fromJson(inputs.linux_host_archs), 'aarch64')
                && '["ubuntu-24.04"]'
                || contains(fromJson(inputs.linux_host_archs), 'aarch64') && !contains(fromJson(inputs.linux_host_archs), 'x86_64')
                && '["ubuntu-24.04-arm"]'
                || '["ubuntu-24.04","ubuntu-24.04-arm"]'
            )
          }}
        exclude:
          - ${{ fromJson(inputs.linux_static_sdk_exclude_swift_versions) }}
          - arch: x86_64
            runner: ubuntu-24.04-arm
          - arch: aarch64
            runner: ubuntu-24.04
    container:
      image: ${{ (contains(matrix.swift_version, 'nightly') && 'swiftlang/swift') || 'swift' }}:${{ matrix.swift_version }}-${{ matrix.os_version }}
    steps:
      - name: Swift version
        run: swift --version
      - name: Clang version
        run: clang --version
      - name: Checkout repository
        uses: actions/checkout@v7
        if: ${{ matrix.os_version != 'amazonlinux2' }}
      - name: Checkout repository
        uses: actions/checkout@v1
        if: ${{ matrix.os_version == 'amazonlinux2' }}
      - name: Checkout swiftlang/github-workflows repository
        if: ${{ matrix.os_version != 'amazonlinux2' && github.repository != 'swiftlang/github-workflows' }}
        uses: actions/checkout@v7
        with:
          repository: swiftlang/github-workflows
          path: github-workflows
      - name: Checkout swiftlang/github-workflows repository
        if: ${{ matrix.os_version == 'amazonlinux2' && github.repository != 'swiftlang/github-workflows' }}
        uses: actions/checkout@v1
        with:
          repository: swiftlang/github-workflows
          path: ${{ github.event.repository.name }}/github-workflows
          ref: main
      - name: Determine script-root path
        id: script_path
        run: |
          if [ "${{ github.repository }}" = "swiftlang/github-workflows" ]; then
            echo "root=$GITHUB_WORKSPACE" >> $GITHUB_OUTPUT
          else
            echo "root=$GITHUB_WORKSPACE/github-workflows" >> $GITHUB_OUTPUT
          fi
      - name: Provide token
        if: ${{ inputs.needs_token }}
        run: |
            echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" >> $GITHUB_ENV
      - name: Set environment variables
        if: ${{ inputs.linux_env_vars }}
        env:
          ENV_VARS: ${{ inputs.linux_env_vars }}
        run: |
            for i in "${ENV_VARS}"
            do
              printf "%s\n" $i >> $GITHUB_ENV
            done
      - name: Pre-build
        # zizmor: ignore[template-injection]
        run: ${{ inputs.linux_pre_build_command }}
      - name: Install Static Linux Swift SDK and build
        timeout-minutes: ${{ inputs.linux_static_sdk_build_timeout }}
        env:
          BUILD_FLAGS: ${{ (contains(matrix.swift_version, 'nightly') && inputs.swift_nightly_flags) || inputs.swift_flags }}
        # zizmor: ignore[template-injection]
        run: |
          ${{ inputs.linux_static_sdk_pre_build_command }}
          ${{ steps.script_path.outputs.root }}/.github/workflows/scripts/install-and-build-with-sdk.sh --static --flags="$BUILD_FLAGS" --build-command="${{ inputs.linux_static_sdk_build_command }}" ${{ matrix.swift_version }}

  wasm-sdk-build:
    name: Swift SDK for Wasm Build (${{ matrix.swift_version }} - ${{ matrix.os_version }})
    if: ${{ inputs.enable_wasm_sdk_build }}
    runs-on: ubuntu-26.04
    strategy:
      fail-fast: false
      matrix:
        swift_version: ${{ fromJson(inputs.wasm_sdk_versions) }}
        os_version: ${{ fromJson(inputs.linux_os_versions) }}
        exclude:
          - ${{ fromJson(inputs.wasm_exclude_swift_versions) }}
    container:
      image: ${{ (contains(matrix.swift_version, 'nightly') && 'swiftlang/swift') || 'swift' }}:${{ matrix.swift_version }}-${{ matrix.os_version }}
    steps:
      - name: Swift version
        run: swift --version
      - name: Clang version
        run: clang --version
      - name: Checkout repository
        uses: actions/checkout@v7
        if: ${{ matrix.os_version != 'amazonlinux2' }}
      - name: Checkout repository
        uses: actions/checkout@v1
        if: ${{ matrix.os_version == 'amazonlinux2' }}
      - name: Checkout swiftlang/github-workflows repository
        if: ${{ matrix.os_version != 'amazonlinux2' && github.repository != 'swiftlang/github-workflows' }}
        uses: actions/checkout@v7
        with:
          repository: swiftlang/github-workflows
          path: github-workflows
      - name: Checkout swiftlang/github-workflows repository
        if: ${{ matrix.os_version == 'amazonlinux2' && github.repository != 'swiftlang/github-workflows' }}
        uses: actions/checkout@v1
        with:
          repository: swiftlang/github-workflows
          path: ${{ github.event.repository.name }}/github-workflows
          ref: main
      - name: Determine script-root path
        id: script_path
        run: |
          if [ "${{ github.repository }}" = "swiftlang/github-workflows" ]; then
            echo "root=$GITHUB_WORKSPACE" >> $GITHUB_OUTPUT
          else
            echo "root=$GITHUB_WORKSPACE/github-workflows" >> $GITHUB_OUTPUT
          fi
      - name: Provide token
        if: ${{ inputs.needs_token }}
        run: |
            echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" >> $GITHUB_ENV
      - name: Set environment variables
        if: ${{ inputs.linux_env_vars }}
        env:
          ENV_VARS: ${{ inputs.linux_env_vars }}
        run: |
            for i in "${ENV_VARS}"
            do
              printf "%s\n" $i >> $GITHUB_ENV
            done
      - name: Pre-build
        # zizmor: ignore[template-injection]
        run: ${{ inputs.linux_pre_build_command }}
      - name: Install Swift SDK for Wasm and build
        timeout-minutes: ${{ inputs.wasm_sdk_build_timeout }}
        env:
          BUILD_FLAGS: ${{ (contains(matrix.swift_version, 'nightly') && inputs.swift_nightly_flags) || inputs.swift_flags }}
        # zizmor: ignore[template-injection]
        run: |
          ${{ inputs.wasm_sdk_pre_build_command }}
          ${{ steps.script_path.outputs.root }}/.github/workflows/scripts/install-and-build-with-sdk.sh --wasm --flags="$BUILD_FLAGS" --build-command="${{ inputs.wasm_sdk_build_command }}" ${{ matrix.swift_version }}

  embedded-wasm-sdk-build:
    name: Embedded Swift SDK for Wasm Build (${{ matrix.swift_version }} - ${{ matrix.os_version }})
    if: ${{ inputs.enable_embedded_wasm_sdk_build }}
    runs-on: ubuntu-26.04
    strategy:
      fail-fast: false
      matrix:
        swift_version: ${{ fromJson(inputs.wasm_sdk_versions) }}
        os_version: ${{ fromJson(inputs.linux_os_versions) }}
        exclude:
          - ${{ fromJson(inputs.wasm_exclude_swift_versions) }}
    container:
      image: ${{ (contains(matrix.swift_version, 'nightly') && 'swiftlang/swift') || 'swift' }}:${{ matrix.swift_version }}-${{ matrix.os_version }}
    steps:
      - name: Swift version
        run: swift --version
      - name: Clang version
        run: clang --version
      - name: Checkout repository
        uses: actions/checkout@v7
        if: ${{ matrix.os_version != 'amazonlinux2' }}
      - name: Checkout repository
        uses: actions/checkout@v1
        if: ${{ matrix.os_version == 'amazonlinux2' }}
      - name: Checkout swiftlang/github-workflows repository
        if: ${{ matrix.os_version != 'amazonlinux2' && github.repository != 'swiftlang/github-workflows' }}
        uses: actions/checkout@v7
        with:
          repository: swiftlang/github-workflows
          path: github-workflows
      - name: Checkout swiftlang/github-workflows repository
        if: ${{ matrix.os_version == 'amazonlinux2' && github.repository != 'swiftlang/github-workflows' }}
        uses: actions/checkout@v1
        with:
          repository: swiftlang/github-workflows
          path: ${{ github.event.repository.name }}/github-workflows
          ref: main
      - name: Determine script-root path
        id: script_path
        run: |
          if [ "${{ github.repository }}" = "swiftlang/github-workflows" ]; then
            echo "root=$GITHUB_WORKSPACE" >> $GITHUB_OUTPUT
          else
            echo "root=$GITHUB_WORKSPACE/github-workflows" >> $GITHUB_OUTPUT
          fi
      - name: Provide token
        if: ${{ inputs.needs_token }}
        run: |
            echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" >> $GITHUB_ENV
      - name: Set environment variables
        if: ${{ inputs.linux_env_vars }}
        env:
          ENV_VARS: ${{ inputs.linux_env_vars }}
        run: |
            for i in "${ENV_VARS}"
            do
              printf "%s\n" $i >> $GITHUB_ENV
            done
      - name: Pre-build
        # zizmor: ignore[template-injection]
        run: ${{ inputs.linux_pre_build_command }}
      - name: Install Swift SDK for Wasm and build
        timeout-minutes: ${{ inputs.wasm_sdk_build_timeout }}
        env:
          BUILD_FLAGS: ${{ (contains(matrix.swift_version, 'nightly') && inputs.swift_nightly_flags) || inputs.swift_flags }}
        # zizmor: ignore[template-injection]
        run: |
          ${{ inputs.wasm_sdk_pre_build_command }}
          ${{ steps.script_path.outputs.root }}/.github/workflows/scripts/install-and-build-with-sdk.sh --embedded-wasm --flags="$BUILD_FLAGS" --build-command="${{ inputs.embedded_wasm_sdk_build_command }}" ${{ matrix.swift_version }}

  android-sdk-build:
    name: Swift SDK for Android Build (${{ matrix.swift_version }} - NDK ${{ matrix.ndk_version }})
    if: ${{ inputs.enable_android_sdk_build }}
    runs-on: ubuntu-26.04
    strategy:
      fail-fast: false
      matrix:
        swift_version: ${{ fromJson(inputs.android_sdk_versions) }}
        ndk_version: ${{ fromJson(inputs.android_ndk_versions) }}
        exclude:
          - ${{ fromJson(inputs.android_exclude_swift_versions) }}
    steps:
      # https://github.com/actions/runner-images/blob/main/images/ubuntu/scripts/build/install-swift.sh
      - name: Remove Swift
        run: |
          sudo rm /usr/local/bin/swift
          sudo rm /usr/local/bin/swiftc
          sudo rm /usr/local/lib/libsourcekitdInProc.so
          sudo rm -r /usr/share/swift
      - name: Checkout repository
        uses: actions/checkout@v7
      - name: Checkout swiftlang/github-workflows repository
        uses: actions/checkout@v7
        with:
          repository: swiftlang/github-workflows
          path: github-workflows
      - name: Determine script-root path
        id: script_path
        run: |
          if [ "${{ github.repository }}" = "swiftlang/github-workflows" ]; then
            echo "root=$GITHUB_WORKSPACE" >> $GITHUB_OUTPUT
          else
            echo "root=$GITHUB_WORKSPACE/github-workflows" >> $GITHUB_OUTPUT
          fi
      - name: Provide token
        if: ${{ inputs.needs_token }}
        run: |
            echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" >> $GITHUB_ENV
      - name: Set environment variables
        if: ${{ inputs.linux_env_vars }}
        env:
          ENV_VARS: ${{ inputs.linux_env_vars }}
        run: |
            for i in "${ENV_VARS}"
            do
              printf "%s\n" $i >> $GITHUB_ENV
            done
      - name: Pre-build
        # zizmor: ignore[template-injection]
        run: ${{ inputs.linux_pre_build_command }}
      - name: Install Swift SDK for Android and build
        timeout-minutes: ${{ inputs.android_sdk_build_timeout }}
        env:
          BUILD_FLAGS: ${{ inputs.enable_android_sdk_checks && '--build-tests' || '' }} ${{ (contains(matrix.swift_version, 'nightly') && inputs.swift_nightly_flags) || inputs.swift_flags }}
        shell: bash
        # zizmor: ignore[template-injection]
        run: |
          ${{ inputs.android_sdk_pre_build_command }}
          ${{ steps.script_path.outputs.root }}/.github/workflows/scripts/install-and-build-with-sdk.sh --android --flags="$BUILD_FLAGS" --build-command="${{ inputs.android_sdk_build_command }}" --android-sdk-triple=${{ join(fromJson(inputs.android_sdk_triples), ' --android-sdk-triple=') }} --android-ndk-version="${{ matrix.ndk_version }}" ${{ matrix.swift_version }}
      - name: Enable KVM and free disk space
        if: ${{ inputs.enable_android_sdk_checks }}
        run: |
          # enable KVM on Linux for tests, else error on emulator launch:
          # CPU acceleration status: This user doesn't have permissions to use KVM (/dev/kvm).
          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
          sudo udevadm control --reload-rules
          sudo udevadm trigger --name-match=kvm

          # need to free space or the emulator runs out
          sudo rm -rf /opt/microsoft /opt/google /opt/az /opt/ghc /usr/share/dotnet /usr/local/share/boost /opt/hostedtoolcache /usr/local/share/chromium
          df -h
      - name: Install Android Emulator and run tests
        timeout-minutes: ${{ inputs.android_sdk_build_timeout }}
        if: ${{ inputs.enable_android_sdk_checks }}
        shell: bash
        # zizmor: ignore[template-injection]
        run: |
          ${{ inputs.android_sdk_pre_build_command }}
          ${{ steps.script_path.outputs.root }}/.github/workflows/scripts/android/android-emulator-tests.sh --android-sdk-triple=${{ join(fromJson(inputs.android_sdk_triples), ' --android-sdk-triple=') }}

  windows-build:
    name: Windows (${{ matrix.swift_version }} - ${{ matrix.os_version }})
    if: ${{ inputs.enable_windows_checks }}
    runs-on: ${{ matrix.os_version }}
    strategy:
      fail-fast: false
      matrix:
        swift_version: ${{ fromJson(inputs.windows_swift_versions) }}
        os_version: ${{ fromJson(inputs.windows_os_versions) }}
        exclude:
          - ${{ fromJson(inputs.windows_exclude_swift_versions) }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v7
      - name: Checkout swiftlang/github-workflows repository
        if: ${{ github.repository != 'swiftlang/github-workflows' }}
        uses: actions/checkout@v7
        with:
          repository: swiftlang/github-workflows
          path: github-workflows
      - name: Determine script-root path
        id: script_path
        run: |
          if ("${{ inputs.enable_windows_docker }}" -eq "true") {
            $source = "C:\source"
          } else {
            $source = $env:GITHUB_WORKSPACE
          }

          if ("${{ github.repository }}" -eq "swiftlang/github-workflows") {
            echo "root=$source" >> $env:GITHUB_OUTPUT
          } else {
            echo "root=$source/github-workflows" >> $env:GITHUB_OUTPUT
          }
      - name: Provide token
        if: ${{ inputs.needs_token }}
        run: |
          echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
      - name: Set environment variables
        if: ${{ inputs.windows_env_vars }}
        env:
          WINDOWS_ENV_VARS: ${{ inputs.windows_env_vars }}
        run: |
          $lines = $env:WINDOWS_ENV_VARS -split "`r`n"
          foreach ($line in $lines) {
              echo $line | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf8 -Append
          }
      - name: Ensure Docker engine is ready
        if: ${{ inputs.enable_windows_docker }}
        run: |
          # Start Docker service
          Write-Host "Starting Docker service..."
          Start-Service docker

          # Wait for Docker to be ready with exponential backoff
          $maxRetries = 10
          $retryCount = 0
          $baseDelay = 1
          $maxDelay = 30
          while ($retryCount -lt $maxRetries) {
            try {
              docker info | Out-Null
              if ($LASTEXITCODE) {
                throw "docker engine is not ready"
              }
              Write-Host "Docker engine is ready"
              break
            } catch {
              $retryCount++
              if ($retryCount -lt $maxRetries) {
                # Exponential backoff: 2^retryCount * baseDelay, capped at maxDelay
                $delay = [Math]::Min([Math]::Pow(2, $retryCount) * $baseDelay, $maxDelay)
                Write-Host "Waiting for Docker engine to be ready... (attempt $retryCount/$maxRetries, waiting $delay seconds)"
                Start-Sleep -Seconds $delay
              }
            }
          }
          if ($retryCount -eq $maxRetries) {
            Write-Error "Docker engine failed to start after $maxRetries attempts"
            exit 1
          }
      - name: Pull Docker image
        id: pull_docker_image
        if: ${{ inputs.enable_windows_docker }}
        run: |
          if ("${{ matrix.swift_version }}".Contains("nightly")) {
            $Image = "swiftlang/swift:${{ matrix.swift_version }}-windowsservercore-ltsc2022"
          } else {
            $Image = "swift:${{ matrix.swift_version }}-windowsservercore-ltsc2022"
          }
          docker pull $Image
          echo "image=$Image" >> "$env:GITHUB_OUTPUT"
      - name: "Install Python 3.10"
        if: ${{ !inputs.enable_windows_docker && !(matrix.swift_version == '6.1' || matrix.swift_version == '6.0' || matrix.swift_version == '5.10' || matrix.swift_version == '5.9') }}
        uses: actions/setup-python@v6
        with:
          python-version: "3.10"
          architecture: "x64"
      - name: "Install Python 3.9"
        if: ${{ !inputs.enable_windows_docker && (matrix.swift_version == '6.1' || matrix.swift_version == '6.0' || matrix.swift_version == '5.10' || matrix.swift_version == '5.9') }}
        uses: actions/setup-python@v6
        with:
          python-version: "3.9"
          architecture: "x64"
      - name: Install Visual Studio Build Tools
        if: ${{ !inputs.enable_windows_docker }}
        run: . ${{ steps.script_path.outputs.root }}/.github/workflows/scripts/windows/install-vsb.ps1
      - name: Install Swift
        if: ${{ !inputs.enable_windows_docker }}
        run: . ${{ steps.script_path.outputs.root }}/.github/workflows/scripts/windows/swift/install-swift-${{ matrix.swift_version }}.ps1
      - name: Create test script
        # zizmor: ignore[template-injection]
        run: |
          mkdir $env:TEMP\test-script
          echo @'
          Set-PSDebug -Trace 1
          if ("${{ inputs.enable_windows_docker }}" -eq "true") {
            $Source = "C:\source"
          } else {
            $Source = $env:GITHUB_WORKSPACE
          }

          # Run the command following `Invoke-Program`.
          # If that command returns a non-zero exit code, return the same exit code from this script.
          # When there is no exit code (e.g. program failed to launch), we fall back to $?.
          function Invoke-Program($Executable) {
            $global:LASTEXITCODE = $null
            & $Executable @args
            $ok = $?
            if ($null -eq $LASTEXITCODE) {
              if (-not $ok) {
                exit 1
              }
            } elseif ($LASTEXITCODE -ne 0) {
              exit $LASTEXITCODE
            }
          }
          Invoke-Program swift --version
          Invoke-Program swift test --version
          Invoke-Program clang --version
          Invoke-Program cd $Source
          '@ >> $env:TEMP\test-script\run.ps1

          if ("${{ inputs.enable_cross_pr_testing && github.event_name == 'pull_request' }}" -eq "true") {
            echo @'
          # Running in script mode fails on Windows (https://github.com/swiftlang/swift/issues/77263), compile and run the script.
          Invoke-Program swiftc -sdk $env:SDKROOT ${{ steps.script_path.outputs.root }}/.github/workflows/scripts/cross-pr-checkout.swift -o $env:TEMP\cross-pr-checkout.exe
          Invoke-Program $env:TEMP\cross-pr-checkout.exe "${{ github.repository }}" "${{ github.event.number }}"
          '@ >> $env:TEMP\test-script\run.ps1
          }

          echo @'
          ${{ inputs.windows_pre_build_command }}
          ${{ inputs.windows_build_command }} ${{ (contains(matrix.swift_version, 'nightly') && inputs.swift_nightly_flags) || inputs.swift_flags }}
          '@ >> $env:TEMP\test-script\run.ps1
      # Docker build
      - name: Docker Build / Test
        timeout-minutes: ${{ inputs.windows_build_timeout }}
        if: ${{ inputs.enable_windows_docker }}
        run: |
          docker run -v ${{ github.workspace }}:C:\source -v $env:TEMP\test-script:C:\test-script ${{ steps.pull_docker_image.outputs.image }} powershell.exe -NoLogo -File C:\test-script\run.ps1
      # Docker-less build
      - name: Build / Test
        timeout-minutes: ${{ inputs.windows_build_timeout }}
        if: ${{ !inputs.enable_windows_docker }}
        run: powershell.exe -NoLogo -File $env:TEMP\test-script\run.ps1; exit $LastExitCode

  freebsd-build:
    name: FreeBSD (${{ matrix.swift_version }} - ${{ matrix.os_version }} - ${{ matrix.arch }})
    if: ${{ inputs.enable_freebsd_checks }}
    runs-on: ${{ matrix.runner }}
    strategy:
      fail-fast: false
      matrix:
        swift_version: ${{ fromJson(inputs.freebsd_swift_versions) }}
        os_version: ${{ fromJson(inputs.freebsd_os_versions) }}
        arch: ${{ fromJson(inputs.freebsd_host_archs) }}
        runner: ${{
            fromJson(
              contains(fromJson(inputs.freebsd_host_archs), 'x86_64') && !contains(fromJson(inputs.freebsd_host_archs), 'aarch64')
                && '["ubuntu-24.04"]'
                || contains(fromJson(inputs.freebsd_host_archs), 'aarch64') && !contains(fromJson(inputs.freebsd_host_archs), 'x86_64')
                && '["ubuntu-24.04-arm"]'
                || '["ubuntu-24.04","ubuntu-24.04-arm"]'
            )
          }}
        exclude:
          - ${{ fromJson(inputs.freebsd_exclude_swift_versions) }}
          - arch: x86_64
            runner: ubuntu-24.04-arm
          - arch: aarch64
            runner: ubuntu-24.04
    steps:
      - name: Checkout repository
        uses: actions/checkout@v7
      - name: Checkout swiftlang/github-workflows repository
        if: ${{ github.repository != 'swiftlang/github-workflows' }}
        uses: actions/checkout@v7
        with:
          repository: swiftlang/github-workflows
          path: github-workflows
      - name: Validate host architecture
        env:
          ARCH: ${{ matrix.arch }}
        run: |
          if [[ "$ARCH" != "x86_64" ]]; then
            echo "::error::FreeBSD builds currently only support x86_64 host architecture"
            exit 1
          fi
      - name: Determine Swift download URL
        id: swift_url
        env:
          SWIFT_VERSION: ${{ matrix.swift_version }}
        run: |
          if [[ "$SWIFT_VERSION" != "nightly-main" ]]; then
            echo "::error::FreeBSD builds currently only support nightly-main Swift version"
            exit 1
          fi
          echo "url=https://download.swift.org/tmp-ci-nightly/development/freebsd-14_ci_latest.tar.gz" >> $GITHUB_OUTPUT
      - name: Provide token
        if: ${{ inputs.needs_token }}
        run: |
            echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" >> $GITHUB_ENV
      - name: Build / Test
        # zizmor: ignore[template-injection]
        uses: vmactions/freebsd-vm@v1
        env:
          SWIFT_WEB_URL: ${{ steps.swift_url.outputs.url }}
          BUILD_FLAGS: ${{ (contains(matrix.swift_version, 'nightly') && inputs.swift_nightly_flags) || inputs.swift_flags }}
          FREEBSD_ENV_VARS: ${{ inputs.freebsd_env_vars }}
        with:
          envs: 'SWIFT_WEB_URL BUILD_FLAGS FREEBSD_ENV_VARS GITHUB_TOKEN'
          release: "${{ matrix.os_version }}"
          arch: "${{ matrix.arch }}"
          sync: rsync
          copyback: false
          usesh: true
          prepare: |
            fetch -o /tmp/swift.tar.gz "$SWIFT_WEB_URL"
            mkdir -p /opt/swift
            tar -xzf /tmp/swift.tar.gz -C /opt/swift
            pkg install -y git sqlite3 libuuid python3 curl brotli bash
            git config --global init.defaultBranch 'main'
            /opt/swift/usr/bin/swift --version
          run: |
            export PATH="/opt/swift/usr/bin:$PATH"
            swift --version
            if [ -n "$FREEBSD_ENV_VARS" ]; then
              printf '%s\n' "$FREEBSD_ENV_VARS" > /tmp/.env_vars
              while IFS= read -r _line || [ -n "$_line" ]; do
                export "$_line"
              done < /tmp/.env_vars
            fi
            if [ "${{ inputs.enable_cross_pr_testing && github.event_name == 'pull_request' }}" = "true" ]; then
              if [ "${{ github.repository }}" = "swiftlang/github-workflows" ]; then
                SCRIPT_ROOT="."
              else
                SCRIPT_ROOT="github-workflows"
              fi
              cat "$SCRIPT_ROOT/.github/workflows/scripts/cross-pr-checkout.swift" > /tmp/cross-pr-checkout.swift
              swift /tmp/cross-pr-checkout.swift "${{ github.repository }}" "${{ github.event.number }}"
            fi
            ${{ inputs.freebsd_pre_build_command }}
            ${{ inputs.freebsd_build_command }} $BUILD_FLAGS