Preserve symlinks in XCArchives and XCFramework (#55)

# Preserve symlinks in XCArchives and XCFramework

## ♻️ Current situation & Problem
Currently, the XCArchives and XCFramework actions don't preserve
symlinks, resulting in build failures for using XCFrameworks on the
macOS platform.


## ⚙️ Release Notes 
- Preserve symlinks in XCArchives and XCFramework


## 📚 Documentation
-


## ✅ Testing
Tested with llama.cpp XCFramework building


### Code of Conduct & Contributing Guidelines 

By submitting creating this pull request, you agree to follow our [Code
of
Conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md)
and [Contributing
Guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md):
- [x] I agree to follow the [Code of
Conduct](https://github.com/StanfordBDHG/.github/blob/main/CODE_OF_CONDUCT.md)
and [Contributing
Guidelines](https://github.com/StanfordBDHG/.github/blob/main/CONTRIBUTING.md).

.github/workflows/archive.yml

@@ -66,7 +66,7 @@ jobs:
           swift --version
           echo Release version: ${{ inputs.version }}
           echo SDK: ${{ matrix.sdk }}
-    - name: Archive for iOS 
+    - name: Archive for ${{ matrix.sdk }} SDK
       run: |
           xcodebuild archive \
             -workspace ${{ inputs.workspaceFile }} \
@@ -80,8 +80,12 @@ jobs:
             CI=TRUE \
             VERSION_NUMBER=${{ inputs.version }} \
             SWIFT_OBJC_INTEROP_MODE=${{ (inputs.cxxInterop && 'objcxx') || 'objc' }}
+    - name: Package the XCArchive   # To preserve symlinks within the XCArchives that are not preserved by the GitHub Actions artifact upload
+      run: |
+          cd .build
+          tar -zcvf ${{ inputs.xcArchiveName }}-${{ matrix.sdk }}.xcarchive.tar.gz ${{ inputs.xcArchiveName }}-${{ matrix.sdk }}.xcarchive
     - name: Upload Artifact
       uses: actions/upload-artifact@v4
       with:
-        name: ${{ inputs.xcArchiveName }}-${{ matrix.sdk }}.xcarchive
-        path: ./.build/${{ inputs.xcArchiveName }}-${{ matrix.sdk }}.xcarchive
+        name: ${{ inputs.xcArchiveName }}-${{ matrix.sdk }}.xcarchive.tar.gz
+        path: ./.build/${{ inputs.xcArchiveName }}-${{ matrix.sdk }}.xcarchive.tar.gz

.github/workflows/xcframework.yml

@@ -32,6 +32,11 @@ on:
         type: string
         required: false
         default: 'Release'
+      dryRun:
+        description: 'If true, the workflow will not commit and release the built XCFramework.'
+        type: boolean
+        required: false
+        default: false
       runsonlabels:
         description: 'JSON-based collection of labels indicating which type of github runner should be chosen.'
         type: string
@@ -84,7 +89,8 @@ jobs:
     - uses: actions/download-artifact@v4
       with:
         path: ./.build
-    - name: Create XCFramework
+        merge-multiple: true
+    - name: Unpack XCArchives and create XCFramework
       run: |
           rm -rf ${{ inputs.xcFrameworkName }}.xcframework
           
@@ -96,6 +102,9 @@ jobs:
           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_PATH="./.build/${{ inputs.xcFrameworkName }}-${SDK}.xcarchive/Products/Library/Frameworks/${{ inputs.xcFrameworkName }}.framework"
               echo "Checking archive path: $ARCHIVE_PATH"
               if [ -d "$ARCHIVE_PATH" ]; then
@@ -115,6 +124,7 @@ jobs:
           rm -rf .build
     - name: Commit and push XCFramework
       uses: EndBug/add-and-commit@v9
+      if: ${{ !inputs.dryRun }}
       with:
         add: ${{ inputs.xcFrameworkName }}.xcframework
         message: Create XCFramework for release ${{ inputs.version }}
@@ -126,8 +136,14 @@ jobs:
     - 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
     - name: Create Release
       uses: softprops/action-gh-release@v1
+      if: ${{ !inputs.dryRun }}
       with:
         tag_name: ${{ inputs.version }}
         generate_release_notes: true