xcframework.yml

#
# This source file is part of the Stanford Biodesign Digital Health Group open-source organization
#
# SPDX-FileCopyrightText: 2022 Stanford University and the project authors (see CONTRIBUTORS.md)
#
# SPDX-License-Identifier: MIT
#

name: Create XCFramework

on:
  workflow_call:
    inputs:
      workspaceFile:
        description: |
          The path of the Xcode Workspace file (including the file extension).
        type: string
        required: true
      xcFrameworkName:
        description: |
          The name of the to be created XCFramework.
          It must not include the default XCFramework extension ".xcframework" as the file naming is automatically done be the workflow.
        type: string
        required: true
      scheme:
        description: |
          The project scheme that should be used for the archiving process.
        type: string
        required: true
      version:
        description: |
          The version number of the XCFramework embedded in the XCArchives.
          This version number is also used for the release tag.
        type: string
        required: false
        default: 'ci'
      configuration:
        description: |
          The build configuration to use when archiving the scheme, either Debug or Release.
        type: string
        required: false
        default: 'Release'
      runsonlabels:
        description: |
          JSON-based collection of labels indicating which type of github runner should be chosen.
        type: string
        required: false
        default: '["macos-14"]'
      sdk:
        description: |
          JSON-based collection of SDK for the exported framework.
          Defaults to all SDKs. You can list SDKs using `xcodebuild -showsdks`.
        type: string
        required: false
        default: '["iphoneos", "iphonesimulator", "macosx", "appletvos", "appletvsimulator", "xros", "xrsimulator", "watchos", "watchsimulator"]'
      outputpath:
        description: 'Optional Prefix for the output path'
        type: string
        required: false
        default: '.'
      user:
        description: |
          Optional GitHub username that is associated with the GitHub Personal Access Token (PAT).
        type: string
        required: false
        default: ''
    secrets:
      access-token:
        description: |
          GitHub Personal Access Token (PAT) if the to-be-commited-to branch is protected and needs a specific access token to push to the branch.
        required: false

jobs:
  build-xcarchive:
    name: Build XCArchive
    uses: StanfordBDHG/.github/.github/workflows/archive.yml@v2
    with:
      workspaceFile: ${{ inputs.workspaceFile }}
      xcArchiveName: ${{ inputs.xcFrameworkName }}
      scheme: ${{ inputs.scheme }}
      version: ${{ inputs.version }}
      configuration: ${{ inputs.configuration }}
      runsonlabels: ${{ inputs.runsonlabels }}
      sdk: ${{ inputs.sdk }}
  create-xcframework:
    name: Build XCFramework
    runs-on: ${{ fromJson(inputs.runsonlabels) }}
    needs: build-xcarchive
    steps:
      - uses: actions/checkout@v4
        with:
          token: ${{ secrets.access-token || github.token }}
      - uses: maxim-lobanov/setup-xcode@v1
        with:
          xcode-version: latest-stable
      - name: Check environment
        run: |
            xcodebuild -version
            swift --version
            echo Release version: ${{ inputs.version }}
      - uses: actions/download-artifact@v4
        with:
          path: ./.build
          merge-multiple: true
      - name: Unpack XCArchives and create XCFramework
        run: |
            rm -rf ${{ inputs.xcFrameworkName }}.xcframework

            # Convert JSON array to space-separated string
            SDK_LIST="${{ inputs.sdk }}"
            SDK_LIST="${SDK_LIST//[\[\]\",]/}" # Remove JSON characters
            echo "Parsed SDK list: $SDK_LIST"

            IFS=' ' read -r -a SDKS <<< "$SDK_LIST"
            FRAMEWORKS_ARGS=""
            for SDK in "${SDKS[@]}"; do
                # Unpack the XCArchive
                tar -zxvf ./.build/${{ inputs.xcFrameworkName }}-${SDK}.xcarchive.tar.gz -C ./.build/
                # Specify the path to the framework within the XCArchive
                ARCHIVE="./.build/${{ inputs.xcFrameworkName }}-${SDK}.xcarchive/Products/Library/Frameworks/${{ inputs.xcFrameworkName }}.framework"
                echo "Checking archive path: $ARCHIVE"
                if [ -d "$ARCHIVE" ]; then
                    FRAMEWORKS_ARGS+="-framework $ARCHIVE "
                    echo "Archive path valid: $ARCHIVE"
                else
                    echo "Warning: Archive path for SDK $SDK does not exist: $ARCHIVE"
                fi
            done

            # Trim trailing space
            FRAMEWORKS_ARGS=$(echo "$FRAMEWORKS_ARGS" | xargs)

            echo "Executing xcodebuild with args: $FRAMEWORKS_ARGS"
            xcodebuild \
              -create-xcframework $FRAMEWORKS_ARGS \
              -output ${{ inputs.xcFrameworkName }}.xcframework \
              | xcbeautify \
              || { echo "xcodebuild failed"; exit 1; }

            rm -rf .build
      - name: Create Artifacts
        run: |
            tar -zcvf ${{ inputs.xcFrameworkName }}.xcframework.tar.gz ${{ inputs.xcFrameworkName }}.xcframework
      - name: Upload Artifact
        uses: actions/upload-artifact@v4
        with:
          name: ${{ inputs.xcFrameworkName }}.xcframework.tar.gz
          path: ${{ inputs.xcFrameworkName }}.xcframework.tar.gz