Clean up the usage of kuler90/build-unity (#531)

sunmou99 · web-flow · commit 7a50e97a83e8 · 2022-11-15T14:08:54.000-08:00
diff --git a/.github/workflows/build_android.yml b/.github/workflows/build_android.yml
@@ -101,13 +101,13 @@ jobs:
         shell: bash
         run: |
           pip install -r scripts/gha/requirements.txt
-
-      - name: Setup Unity
-        uses: kuler90/setup-unity@v1
+      
+      - id: unity_setup
+        uses: ./gha/unity
         timeout-minutes: 30
         with:
-          unity-version: 2020.3.34f1
-          unity-modules: android
+          version: ${{ inputs.unity_version }}
+          platforms: ${{ inputs.unity_platform_name }}
 
       - name: Display Swig Version
         shell: bash
diff --git a/.github/workflows/build_ios.yml b/.github/workflows/build_ios.yml
@@ -81,12 +81,12 @@ jobs:
         run: |
           pip install -r scripts/gha/requirements.txt
       
-      - name: Setup Unity
-        uses: kuler90/setup-unity@v1
+      - id: unity_setup
+        uses: ./gha/unity
         timeout-minutes: 30
         with:
-          unity-version: 2020.3.34f1
-          unity-modules: ios
+          version: ${{ inputs.unity_version }}
+          platforms: ${{ inputs.unity_platform_name }}
 
       - name: Build SDK (iOS)
         timeout-minutes: 90
diff --git a/.github/workflows/build_linux.yml b/.github/workflows/build_linux.yml
@@ -83,11 +83,12 @@ jobs:
         run: |
           sudo apt install openssl
 
-      - name: Setup Unity
-        uses: kuler90/setup-unity@v1
+      - id: unity_setup
+        uses: ./gha/unity
         timeout-minutes: 30
         with:
-          unity-version: 2020.3.40f1
+          version: ${{ inputs.unity_version }}
+          platforms: ${{ inputs.unity_platform_name }}
 
       - name: Setup Swig Env
         shell: bash
diff --git a/.github/workflows/build_macos.yml b/.github/workflows/build_macos.yml
@@ -97,13 +97,12 @@ jobs:
           # brew won't overwrite MacOS system default OpenSSL, so force it here.
           echo "OPENSSL_ROOT_DIR=$(brew --prefix openssl --installed)" >> $GITHUB_ENV
 
-      - name: Setup Unity
-        uses: kuler90/setup-unity@v1
+      - id: unity_setup
+        uses: ./gha/unity
         timeout-minutes: 30
         with:
-          unity-version: 2020.3.34f1
-          # Include iOS for the editor tools
-          unity-modules: ios
+          version: ${{ inputs.unity_version }}
+          platforms: ${{ inputs.unity_platform_name }}
 
       - name: Setup Swig Env
         shell: bash
diff --git a/.github/workflows/build_tvos.yml b/.github/workflows/build_tvos.yml
@@ -108,12 +108,12 @@ jobs:
         run: |
           pod repo add cocoapods https://github.com/CocoaPods/Specs.git
 
-      - name: Setup Unity
-        uses: kuler90/setup-unity@v1
+      - id: unity_setup
+        uses: ./gha/unity
         timeout-minutes: 30
         with:
-          unity-version: 2020.3.34f1
-          unity-modules: appletv
+          version: ${{ inputs.unity_version }}
+          platforms: ${{ inputs.unity_platform_name }}
 
       - name: Build SDK (tvOS)
         timeout-minutes: 90
diff --git a/.github/workflows/build_windows.yml b/.github/workflows/build_windows.yml
@@ -89,11 +89,12 @@ jobs:
         run: |
           choco install openssl -r
 
-      - name: Setup Unity
-        uses: kuler90/setup-unity@v1
+      - id: unity_setup
+        uses: ./gha/unity
         timeout-minutes: 30
         with:
-          unity-version: 2020.3.34f1
+          version: ${{ inputs.unity_version }}
+          platforms: ${{ inputs.unity_platform_name }}
 
       - name: Setup Swig Env
         shell: bash
diff --git a/.github/workflows/integration_tests.yml b/.github/workflows/integration_tests.yml
@@ -184,72 +184,15 @@ jobs:
       - name: setup Xcode version
         if: runner.os == 'macOS'
         run: sudo xcode-select -s /Applications/Xcode_${{ env.xcodeVersion }}.app/Contents/Developer
-
-      - name: Setup Unity (Android)
-        if: ${{ contains(matrix.platform, 'Android') }}
-        uses: kuler90/setup-unity@v1
-        timeout-minutes: 30
-        with:
-          unity-version: 2020.3.34f1
-          unity-modules: android
-      # Because of a bug, include iOS for the editor tools
-      - name: Setup Unity (Android, Part 2)
-        if: ${{ contains(matrix.platform, 'Android') }}
-        uses: kuler90/setup-unity@v1
+      - id: unity_setup
+        uses: ./gha/unity
         timeout-minutes: 30
         with:
-          unity-version: 2020.3.34f1
-          unity-modules: ios
-
-      - name: Setup Unity (iOS)
-        if: ${{ contains(matrix.platform, 'iOS') }}
-        uses: kuler90/setup-unity@v1
-        timeout-minutes: 30
-        with:
-          unity-version: 2020.3.34f1
-          unity-modules: ios
-
-      - name: Setup Unity (Desktop Windows)
-        if: ${{ !contains(matrix.platform, 'Android') && !contains(matrix.platform, 'iOS') && runner.os != 'macOS' }}
-        uses: kuler90/setup-unity@v1
-        timeout-minutes: 30
-        with:
-          unity-version: 2020.3.34f1
-          unity-modules: mac-mono
-      - name: Setup Unity (Desktop Windows Part 2)
-        if: ${{ !contains(matrix.platform, 'Android') && !contains(matrix.platform, 'iOS') && runner.os != 'macOS' }}
-        uses: kuler90/setup-unity@v1
-        timeout-minutes: 30
-        with:
-          unity-version: 2020.3.34f1
-          unity-modules: linux-mono
-
-      - name: Setup Unity (Desktop macOS)
-        if: ${{ !contains(matrix.platform, 'Android') && !contains(matrix.platform, 'iOS') && runner.os == 'macOS' }}
-        uses: kuler90/setup-unity@v1
-        timeout-minutes: 30
-        with:
-          unity-version: 2020.3.34f1
-          unity-modules: windows-mono
-      - name: Setup Unity (Desktop macOS Part 2)
-        if: ${{ !contains(matrix.platform, 'Android') && !contains(matrix.platform, 'iOS') && runner.os == 'macOS' }}
-        uses: kuler90/setup-unity@v1
-        timeout-minutes: 30
-        with:
-          unity-version: 2020.3.34f1
-          unity-modules: linux-mono
-
-      - name: Activate Unity license
-        shell: bash
-        run: |
-          python gha/unity/unity_installer.py --activate_license \
-            --version 2020  \
-            --username "${{ secrets.UNITY_USERNAME }}" \
-            --password "${{ secrets.UNITY_PASSWORD }}" \
-            --serial_ids "${{ secrets.SERIAL_ID }}" \
-            --logfile "testapps/activate_license.log"
-          cat testapps/activate_license.log
-
+          version: ${{ matrix.unity_version }}
+          platforms: ${{ matrix.platform }}
+          username: ${{ secrets.UNITY_USERNAME }}
+          password: ${{ secrets.UNITY_PASSWORD }}
+          serial_ids: ${{ secrets.SERIAL_ID }}
       - name: Prepare for integration tests
         timeout-minutes: 10
         shell: bash
@@ -275,28 +218,21 @@ jobs:
           fi
           python scripts/gha/build_testapps.py \
             --t ${{ needs.check_and_prepare.outputs.apis }} \
-            --u 2020.3.34f1 \
+            --u ${{ env.UNITY_VERSION }} \
             --p "${{ matrix.platform }}" \
             --ios_sdk "${{ matrix.ios_sdk }}" \
             --plugin_dir ~/Downloads/firebase_unity_sdk \
             --output_directory "${{ github.workspace }}" \
             --artifact_name "${{ steps.matrix_info.outputs.info }}" \
             --force_latest_runtime \
             --ci
-
       - name: Return Unity license
+        # Always returns true, even when job failed or canceled. But will not run when a critical failure prevents the task from running. 
         if: always()
-        uses: nick-invision/retry@v2
+        uses: ./gha/unity
         with:
-          timeout_minutes: 5
-          max_attempts: 2
-          shell: bash
-          command: |
-            python gha/unity/unity_installer.py --release_license \
-              --version 2020 \
-              --logfile "testapps/release_license.log"
-            cat testapps/release_license.log
-
+          version: ${{ matrix.unity_version }}
+          release_license: "true"
       - name: Prepare results summary artifact
         if: ${{ !cancelled() }}
         shell: bash
@@ -422,23 +358,15 @@ jobs:
         shell: bash
         run: |
           pip install -r scripts/gha/requirements.txt
-      - name: Setup Unity
-        uses: kuler90/setup-unity@v1
+      - id: unity_setup
+        uses: ./gha/unity
         timeout-minutes: 30
         with:
-          unity-version: 2020.3.34f1
-          # Install ios for the editor tools
-          unity-modules: ios
-      - name: Activate Unity license
-        shell: bash
-        run: |
-          python gha/unity/unity_installer.py --activate_license \
-            --version 2020  \
-            --username "${{ secrets.UNITY_USERNAME }}" \
-            --password "${{ secrets.UNITY_PASSWORD }}" \
-            --serial_ids "${{ secrets.SERIAL_ID }}" \
-            --logfile "testapps/activate_license.log"
-          cat testapps/activate_license.log
+          version: ${{ matrix.unity_version }}
+          platforms: Playmode
+          username: ${{ secrets.UNITY_USERNAME }}
+          password: ${{ secrets.UNITY_PASSWORD }}
+          serial_ids: ${{ secrets.SERIAL_ID }}
       - name: Prepare for integration tests
         timeout-minutes: 10
         shell: bash
@@ -462,25 +390,20 @@ jobs:
           fi
           python scripts/gha/build_testapps.py \
             --t ${{ needs.check_and_prepare.outputs.apis }} \
-            --u 2020.3.34f1 \
+            --u ${{ env.UNITY_VERSION }} \
             --p Playmode \
             --plugin_dir ~/Downloads/firebase_unity_sdk \
             --output_directory "${{ github.workspace }}" \
             --artifact_name "${{ steps.matrix_info.outputs.info }}" \
             --force_latest_runtime \
             --ci
       - name: Return Unity license
+        # Always returns true, even when job failed or canceled. But will not run when a critical failure prevents the task from running. 
         if: always()
-        uses: nick-invision/retry@v2
+        uses: ./gha/unity
         with:
-          timeout_minutes: 5
-          max_attempts: 2
-          shell: bash
-          command: |
-            python gha/unity/unity_installer.py --release_license \
-              --version 2020 \
-              --logfile "testapps/release_license.log"
-            cat testapps/release_license.log
+          version: ${{ matrix.unity_version }}
+          release_license: "true"
       - name: Prepare results summary artifact
         if: ${{ !cancelled() }}
         shell: bash
@@ -562,7 +485,7 @@ jobs:
           test_type: "game-loop"
           test_devices: ${{ matrix.device_detail }}
       - name: Read FTL Test Result
-        if: ${{ matrix.device_type == 'real' }}
+        if: ${{ matrix.device_type == 'real' && !cancelled() }}
         timeout-minutes: 60
         shell: bash
         run: |
diff --git a/gha/unity/README.md b/gha/unity/README.md
@@ -15,7 +15,7 @@
 
 ## Output
 
-This GitHub Action will provide `unity_version` (full unity version) output and `UNITY_ROOT_DIR` (Unity project directory) environment variable 
+This GitHub Action will provide `UNITY_VERSION` (full unity version) and `UNITY_ROOT_DIR` (Unity project directory) environment variable 
 
 -   Output usage:
     ```yml
@@ -25,8 +25,8 @@ This GitHub Action will provide `unity_version` (full unity version) output and
         version: ${{ unity_version }}
         platforms: ${{ platforms }}
     - run: |
-        echo '${{ steps.unity_setup.outputs.unity_version }}'
-        echo '$UNITY_ROOT_DIR'
+        echo '${{ env.UNITY_VERSION }}'
+        echo '${{ env.UNITY_ROOT_DIR }}'
     ```
 
 ## Usage
@@ -69,7 +69,7 @@ This GitHub Action will provide `unity_version` (full unity version) output and
               release_license: "true"
     ```
 
-## How to upgrade supported unity versions
+## [Deprecated] How to upgrade supported unity versions
 **Background**
 
 This GitHub Action leverages [U3D](github.com/DragonBox/u3d), which is a command line tool for working with Unity from the command line on all three operating systems. 
diff --git a/gha/unity/action.yml b/gha/unity/action.yml
@@ -27,10 +27,6 @@ inputs:
   release_license:
     required: false
 
-outputs:
-  unity_version:
-    value: ${{ steps.unity_installation.outputs.unity_version }}
-
 runs:
   using: 'composite'
   steps:
@@ -46,40 +42,26 @@ runs:
             --version ${{ inputs.version }} \
             --logfile "testapps/release_license.log"
           cat testapps/release_license.log
-    - name: Install Unity installer (U3D)
-      if: inputs.release_license == ''
-      uses: nick-invision/retry@v2
-      with:
-        timeout_minutes: 10
-        max_attempts: 2
-        shell: bash
-        command: gem install u3d -v 1.2.3
-    - name: Set the Unity Env
+    - name: unity_setting
       if: inputs.release_license == ''
       shell: bash
       run: |
-        echo "LC_ALL=en_US.UTF-8" >> $GITHUB_ENV
-        echo "LANG=en_US.UTF-8" >> $GITHUB_ENV
-        echo "U3D_PASSWORD=" >> $GITHUB_ENV
-        echo "U3D_SKIP_UPDATE_CHECK=1" >> $GITHUB_ENV
-    - name: Download Unity Fallback
-      if: inputs.release_license == '' && startsWith(matrix.os, 'windows')
-      shell: bash
-      run: |
-        mkdir -p ~/Downloads
-        curl -L https://download.unity3d.com/download_unity/9a4c9c70452b/Windows64EditorInstaller/UnitySetup64.exe -o ~/Downloads/UnityInstaller.exe
-        ls -l ~/Downloads/
-    - id: unity_installation
-      name: Install Unity
+        unity_info=$( python $GITHUB_ACTION_PATH/unity_installer.py --setting --version ${{ inputs.version }})
+        echo "UNITY_VERSION=$(cut -d',' -f1 <<< ${unity_info})" >> $GITHUB_ENV
+        echo "UNITY_ROOT_DIR=$(cut -d',' -f2 <<< ${unity_info})" >> $GITHUB_ENV
+    - name: Install Unity
+      if: inputs.release_license == ''
+      uses: kuler90/setup-unity@v1
+      with:
+        unity-version: ${{ env.UNITY_VERSION }}
+    - name: Install Unity Modules
       if: inputs.release_license == ''
       shell: bash
       run: |
         if [[ -n "${{ inputs.platforms }}" ]]; then
           additional_flags+=(--platforms ${{ inputs.platforms }})
         fi
-        unity_info=$( python $GITHUB_ACTION_PATH/unity_installer.py --install --version ${{ inputs.version }} ${additional_flags[*]} )
-        echo "UNITY_ROOT_DIR=$(cut -d',' -f2 <<< ${unity_info})" >> $GITHUB_ENV
-        echo "unity_version=$(cut -d',' -f1 <<< ${unity_info})" >> $GITHUB_OUTPUT
+        python $GITHUB_ACTION_PATH/unity_installer.py --install_modules --version ${{ inputs.version }} ${additional_flags[*]} 
     - name: Activate Unity license
       if: inputs.release_license == '' && inputs.username != '' && inputs.password != '' && inputs.serial_ids != ''
       shell: bash
diff --git a/gha/unity/unity_installer.py b/gha/unity/unity_installer.py
