ci: unify Swift selection, runner OS across actions (#41)

nekrich · web-flow · commit 645aff856aa0 · 2025-07-02T12:22:25.000+03:00
* chore: update release docs

* chore: bump BinaryDependenciesManager  version

* ci: universal approach to caching and swift selection

* chore: save

* chore: ci

* fix: action template path

* fix: action template

* chore: remove ENV output
diff --git a/.github/workflows/build-multi-platform-binary.yml b/.github/workflows/build-multi-platform-binary.yml
@@ -9,6 +9,9 @@ on:
       - '*'
 
 jobs:
+  load-env:
+    uses: ./.github/workflows/load-env.yml
+
   create-release:
     runs-on: ubuntu-latest
     outputs:
@@ -33,22 +36,27 @@ jobs:
       run: node ./.github/workflows/scripts/build-multi-platform-binary/check-release.js
 
   build-binary:
-    needs: create-release
+    needs: [load-env, create-release]
+    env:
+      package_name: ${{ needs.load-env.outputs.package-name }}
     strategy:
       matrix:
         include:
-          - os: macos-latest
-            platform: macOS
+          - os: ${{ needs.load-env.outputs.macOS-runner-os }}
             arch: universal
-          - os: macos-latest
-            platform: macOS
+            xcode-version: ${{ needs.load-env.outputs.xcode-version }}
+            swift-version: ${{ needs.load-env.outputs.swift-version }}
+          - os: ${{ needs.load-env.outputs.macOS-runner-os }}
             arch: arm64
-          - os: macos-latest
-            platform: macOS
+            xcode-version: ${{ needs.load-env.outputs.xcode-version }}
+            swift-version: ${{ needs.load-env.outputs.swift-version }}
+          - os: ${{ needs.load-env.outputs.macOS-runner-os }}
             arch: x86_64
+            xcode-version: ${{ needs.load-env.outputs.xcode-version }}
+            swift-version: ${{ needs.load-env.outputs.swift-version }}
           - os: ubuntu-latest
-            platform: linux
             arch: x86_64
+            swift-version: ${{ needs.load-env.outputs.swift-version }}
     runs-on: ${{ matrix.os }}
 
     steps:
@@ -60,13 +68,25 @@ jobs:
     - name: Checkout tag
       run: git checkout ${{ needs.create-release.outputs.tag_name }}
 
+    - name: Select Swift Version
+      uses: ./.github/workflows/templates/select-swift-version/
+      with:
+        xcode-version: ${{ matrix.xcode-version }}
+        swift-version: ${{ matrix.swift-version }}
+
+    - name: Cache Swift Packages
+      uses: ./.github/workflows/templates/swift-cache/
+      with:
+        package-name: ${{ env.package_name }}
+        build-system: swift
+
     - name: Check if asset already exists
       id: check-asset
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         RELEASE_ID: ${{ needs.create-release.outputs.release_id }}
         TAG_NAME: ${{ needs.create-release.outputs.tag_name }}
-        PLATFORM: ${{ matrix.platform }}
+        PLATFORM: ${{ runner.os }}
         ARCH: ${{ matrix.arch }}
       run: node ./.github/workflows/scripts/build-multi-platform-binary/check-asset.js
 
@@ -75,7 +95,7 @@ jobs:
       if: steps.check-asset.outputs.asset_exists == 'false'
       env:
         TAG_NAME: ${{ needs.create-release.outputs.tag_name }}
-        PLATFORM: ${{ matrix.platform }}
+        PLATFORM: ${{ runner.os }}
         ARCH: ${{ matrix.arch }}
       run: ./.github/workflows/scripts/build-multi-platform-binary/build-binary.sh
 
diff --git a/.github/workflows/load-env.yml b/.github/workflows/load-env.yml
@@ -0,0 +1,56 @@
+name: Load Environment
+
+on:
+  workflow_call:
+    inputs:
+      package-name:
+        description: 'Swift package name'
+        type: string
+        required: false
+        default: 'binary-dependencies-manager'
+      swift-version:
+        description: 'Swift version'
+        type: string
+        required: false
+        default: '6.1'
+      xcode-version:
+        description: 'Xcode version'
+        type: string
+        required: false
+        default: '16.4'
+      macOS-runner-os:
+        description: 'macOS runner OS (macos-15, macos-latest)'
+        type: string
+        required: false
+        default: 'macos-15'
+    outputs:
+      package-name:
+        description: 'Swift package name'
+        value: ${{ jobs.load-env.outputs.package-name }}
+      swift-version:
+        description: 'Swift version'
+        value: ${{ jobs.load-env.outputs.swift-version }}
+      xcode-version:
+        description: 'Xcode version'
+        value: ${{ jobs.load-env.outputs.xcode-version }}
+      macOS-runner-os:
+        description: 'macOS runner OS'
+        value: ${{ jobs.load-env.outputs.macOS-runner-os }}
+
+jobs:
+  load-env:
+    runs-on: ubuntu-latest
+    outputs:
+      package-name: ${{ steps.common-env.outputs.package-name }}
+      swift-version: ${{ steps.common-env.outputs.swift-version }}
+      xcode-version: ${{ steps.common-env.outputs.xcode-version }}
+      macOS-runner-os: ${{ steps.common-env.outputs.macOS-runner-os }}
+    steps:
+      - name: Setup Common Environment
+        id: common-env
+        shell: bash
+        run: |
+          echo "package-name=${{ inputs.package-name }}" >> $GITHUB_OUTPUT
+          echo "swift-version=${{ inputs.swift-version }}" >> $GITHUB_OUTPUT
+          echo "xcode-version=${{ inputs.xcode-version }}" >> $GITHUB_OUTPUT
+          echo "macOS-runner-os=${{ inputs.macOS-runner-os }}" >> $GITHUB_OUTPUT
diff --git a/.github/workflows/scripts/build-multi-platform-binary/build-binary.sh b/.github/workflows/scripts/build-multi-platform-binary/build-binary.sh
@@ -33,7 +33,7 @@ elif [ "$PLATFORM" == "macOS" ] && [[ "$ARCH" == "arm64" || "$ARCH" == "x86_64"
     # Verify the binary
     echo "Verifying binary..."
     file build/$BINARY_NAME
-elif [ "$PLATFORM" == "linux" ] && [ "$ARCH" == "x86_64" ]; then
+elif [ "$PLATFORM" == "Linux" ] && [ "$ARCH" == "x86_64" ]; then
     # Build for Linux x86_64
     echo "Building for Linux x86_64..."
     swift build --configuration release
@@ -54,7 +54,7 @@ cd build
 if [ "$PLATFORM" == "macOS" ]; then
     # Use ditto on macOS
     ditto -c -k --sequesterRsrc --keepParent $BINARY_NAME "../$ARCHIVE_NAME"
-elif [ "$PLATFORM" == "linux" ]; then
+elif [ "$PLATFORM" == "Linux" ]; then
     # Use zip on Linux
     zip "../$ARCHIVE_NAME" $BINARY_NAME
 else
diff --git a/.github/workflows/templates/select-swift-version/action.yaml b/.github/workflows/templates/select-swift-version/action.yaml
@@ -0,0 +1,28 @@
+name: 'Select Swift Version'
+description: 'Select Xcode version for Swift compilation'
+inputs:
+  xcode-version:
+    description: 'Xcode version to select'
+    required: false
+    default: '16.4'
+  swift-version:
+    description: 'Swift version to select'
+    required: false
+    default: ''
+runs:
+  using: 'composite'
+  steps:
+    - name: Setup Xcode
+      # Select Xcode for swift and xcodebuild.
+      # We need 6.1 swift and setup-swift@v2 is broken.
+      if: ${{ inputs.xcode-version != '' && runner.os == 'macOS' }}
+      shell: bash
+      run: sudo xcode-select -s '/Applications/Xcode_${{ inputs.xcode-version }}.app'
+
+    # Issues: https://github.com/swift-actions/setup-swift/issues/694, https://github.com/swift-actions/setup-swift/issues/739
+    # Author is focused on new action version: https://github.com/swift-actions/setup-swift/pull/710
+    # - name: Setup Swift (Linux)
+    #   if: ${{ inputs.swift-version != '' && runner.os == 'Linux' }}
+    #   uses: swift-actions/setup-swift@v2
+    #   with:
+    #     swift-version: ${{ matrix.swift-version }}
diff --git a/.github/workflows/templates/swift-cache/action.yaml b/.github/workflows/templates/swift-cache/action.yaml
@@ -0,0 +1,27 @@
+name: 'Cache Swift Packages'
+description: 'Cache Swift Package Manager dependencies and build artifacts'
+inputs:
+  package-name:
+    description: 'Name of the Swift package'
+    required: true
+  build-system:
+    description: 'Build system being used (swift or xcodebuild)'
+    required: true
+    default: ''
+runs:
+  using: 'composite'
+  steps:
+    - name: Cache Swift packages
+      uses: actions/cache@v4
+      with:
+        path: |
+          .build/artifacts
+          .build/checkouts
+          .build/repositories
+          .build/workspace-state.json
+          DerivedData/${{ inputs.package-name }}/SourcePackages
+          ~/Library/Caches/org.swift.swiftpm/
+          ~/.cache/org.swift.swiftpm/
+        key: ${{ runner.os }}-${{ inputs.build-system }}-spm-${{ hashFiles('**/Package.resolved') }}
+        restore-keys: |
+          ${{ runner.os }}-${{ inputs.build-system }}-spm-
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -4,61 +4,47 @@ on:
   pull_request:
     branches:
       - main
-      - chore/refactor
 
 jobs:
+  load-env:
+    uses: ./.github/workflows/load-env.yml
+
   test:
+    needs: 'load-env'
     env:
-      package_name: binary-dependencies-manager
+      package_name: ${{ needs.load-env.outputs.package-name }}
 
     strategy:
       matrix:
         include:
-          - os: macos-15
+          - os: ${{ needs.load-env.outputs.macOS-runner-os }}
             build-system: swift
-            swift-version: '6.1'
-            xcode-version: '16.4'
+            swift-version: ${{ needs.load-env.outputs.swift-version }}
+            xcode-version: ${{ needs.load-env.outputs.xcode-version }}
           - os: ubuntu-latest
             build-system: swift
-            swift-version: '6.1'
-          - os: macos-15
+            swift-version: ${{ needs.load-env.outputs.swift-version }}
+          - os: ${{ needs.load-env.outputs.macOS-runner-os }}
             build-system: xcodebuild
-            xcode-version: '16.4'
+            xcode-version: ${{ needs.load-env.outputs.xcode-version }}
 
     runs-on: ${{ matrix.os }}
 
     steps:
     - name: Checkout repository
       uses: actions/checkout@v4
 
-    # Issues: https://github.com/swift-actions/setup-swift/issues/694, https://github.com/swift-actions/setup-swift/issues/739
-    # Author is focused on new action version: https://github.com/swift-actions/setup-swift/pull/710
-    # - name: Setup Swift (Linux)
-    #   if: matrix.os == 'ubuntu-latest'
-    #   uses: swift-actions/setup-swift@v2
-    #   with:
-    #     swift-version: ${{ matrix.swift-version }}
-
-    - name: Setup Xcode
-      # Select Xcode for swift and xcodebuild.
-      # We need 6.1 swift and setup-swift@v2 is broken.
-      if: matrix.xcode-version != ''
-      run: sudo xcode-select -s '/Applications/Xcode_${{ matrix.xcode-version }}.app'
+    - name: Select Swift Version
+      uses: ./.github/workflows/templates/select-swift-version/
+      with:
+        xcode-version: ${{ matrix.xcode-version }}
+        swift-version: ${{ matrix.swift-version }}
 
-    - name: Cache Swift packages
-      uses: actions/cache@v4
+    - name: Cache Swift Packages
+      uses: ./.github/workflows/templates/swift-cache/
       with:
-        path: |
-          .build/artifacts
-          .build/checkouts
-          .build/repositories
-          .build/workspace-state.json
-          DerivedData/${{ env.package_name }}/SourcePackages
-          ~/Library/Caches/org.swift.swiftpm/
-          ~/.cache/org.swift.swiftpm/
-        key: ${{ runner.os }}-${{ matrix.build-system }}-spm-${{ hashFiles('**/Package.resolved') }}
-        restore-keys: |
-          ${{ runner.os }}-${{ matrix.build-system }}-spm-
+        package-name: ${{ env.package_name }}
+        build-system: ${{ matrix.build-system }}
 
     - name: Build with Swift Package Manager
       if: matrix.build-system == 'swift'
