Merge branch 'main' into cloud-runner-develop

# Conflicts:
#	dist/index.js.map

.github/pull_request_template.md

@@ -12,6 +12,9 @@
 
 #### Successful Workflow Run Link
 
+PRs don't have access to secrets so you will need to provide a link to a successful run of the workflows from your own
+repo.
+
 - ...
 
 #### Checklist

.github/workflows/build-tests-mac.yml

@@ -37,7 +37,7 @@ jobs:
       ###########################
       #          Cache          #
       ###########################
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: ${{ matrix.projectPath }}/Library
           key: Library-${{ matrix.projectPath }}-macos-${{ matrix.targetPlatform }}
@@ -61,6 +61,7 @@ jobs:
           UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
           UNITY_SERIAL: ${{ secrets.UNITY_SERIAL }}
         with:
+          buildName: 'GameCI Test Build'
           projectPath: ${{ matrix.projectPath }}
           unityVersion: ${{ matrix.unityVersion }}
           targetPlatform: ${{ matrix.targetPlatform }}
@@ -71,8 +72,8 @@ jobs:
       ###########################
       #          Upload         #
       ###########################
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
-          name: Build MacOS (${{ matrix.unityVersion }})
+          name: Build ${{ matrix.targetPlatform }} on MacOS (${{ matrix.unityVersion }})
           path: build
           retention-days: 14

.github/workflows/build-tests-ubuntu.yml

@@ -69,7 +69,7 @@ jobs:
       ###########################
       #          Cache          #
       ###########################
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: ${{ matrix.projectPath }}/Library
           key: Library-${{ matrix.projectPath }}-ubuntu-${{ matrix.targetPlatform }}
@@ -88,6 +88,7 @@ jobs:
           UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
           UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
         with:
+          buildName: 'GameCI Test Build'
           projectPath: ${{ matrix.projectPath }}
           unityVersion: ${{ matrix.unityVersion }}
           targetPlatform: ${{ matrix.targetPlatform }}
@@ -108,6 +109,7 @@ jobs:
           UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
           UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
         with:
+          buildName: 'GameCI Test Build'
           projectPath: ${{ matrix.projectPath }}
           unityVersion: ${{ matrix.unityVersion }}
           targetPlatform: ${{ matrix.targetPlatform }}
@@ -128,6 +130,7 @@ jobs:
           UNITY_EMAIL: ${{ secrets.UNITY_EMAIL }}
           UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
         with:
+          buildName: 'GameCI Test Build'
           projectPath: ${{ matrix.projectPath }}
           unityVersion: ${{ matrix.unityVersion }}
           targetPlatform: ${{ matrix.targetPlatform }}
@@ -138,8 +141,8 @@ jobs:
       ###########################
       #          Upload         #
       ###########################
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
-          name: Build Ubuntu (${{ matrix.unityVersion }})
+          name: Build ${{ matrix.targetPlatform }} on Ubuntu (${{ matrix.unityVersion }})
           path: build
           retention-days: 14

.github/workflows/build-tests-windows.yml

@@ -39,7 +39,7 @@ jobs:
       ###########################
       #          Cache          #
       ###########################
-      - uses: actions/cache@v3
+      - uses: actions/cache@v4
         with:
           path: ${{ matrix.projectPath }}/Library
           key: Library-${{ matrix.projectPath }}-windows-${{ matrix.targetPlatform }}
@@ -67,6 +67,7 @@ jobs:
           UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
           UNITY_SERIAL: ${{ secrets.UNITY_SERIAL }}
         with:
+          buildName: 'GameCI Test Build'
           projectPath: ${{ matrix.projectPath }}
           unityVersion: ${{ matrix.unityVersion }}
           targetPlatform: ${{ matrix.targetPlatform }}
@@ -90,6 +91,7 @@ jobs:
           UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
           UNITY_SERIAL: ${{ secrets.UNITY_SERIAL }}
         with:
+          buildName: 'GameCI Test Build'
           projectPath: ${{ matrix.projectPath }}
           unityVersion: ${{ matrix.unityVersion }}
           targetPlatform: ${{ matrix.targetPlatform }}
@@ -112,6 +114,7 @@ jobs:
           UNITY_PASSWORD: ${{ secrets.UNITY_PASSWORD }}
           UNITY_SERIAL: ${{ secrets.UNITY_SERIAL }}
         with:
+          buildName: 'GameCI Test Build'
           projectPath: ${{ matrix.projectPath }}
           unityVersion: ${{ matrix.unityVersion }}
           targetPlatform: ${{ matrix.targetPlatform }}
@@ -122,8 +125,8 @@ jobs:
       ###########################
       #          Upload         #
       ###########################
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
-          name: Build Windows (${{ matrix.unityVersion }})
+          name: Build ${{ matrix.targetPlatform }} on Windows (${{ matrix.unityVersion }})
           path: build
           retention-days: 14

action.yml

@@ -270,5 +270,5 @@ branding:
   icon: 'box'
   color: 'gray-dark'
 runs:
-  using: 'node16'
+  using: 'node20'
   main: 'dist/index.js'

dist/platforms/mac/steps/build.sh

@@ -129,7 +129,7 @@ echo ""
 
 /Applications/Unity/Hub/Editor/$UNITY_VERSION/Unity.app/Contents/MacOS/Unity \
   -logFile - \
-  -quit \
+  $( [ "${MANUAL_EXIT}" == "true" ] || echo "-quit" ) \
   -batchmode \
   -nographics \
   -username "$UNITY_EMAIL" \

dist/platforms/ubuntu/steps/activate.sh

@@ -84,11 +84,12 @@ else
   #
   echo "License activation strategy could not be determined."
   echo ""
-  echo "Visit https://game.ci/docs/github/getting-started for more"
+  echo "Visit https://game.ci/docs/github/activation for more"
   echo "details on how to set up one of the possible activation strategies."
 
   echo "::error ::No valid license activation strategy could be determined. Make sure to provide UNITY_EMAIL, UNITY_PASSWORD, and either a UNITY_SERIAL \
-or UNITY_LICENSE. Otherwise please use UNITY_LICENSING_SERVER."
+or UNITY_LICENSE. Otherwise please use UNITY_LICENSING_SERVER. See more info at https://game.ci/docs/github/activation"
+
   # Immediately exit as no UNITY_EXIT_CODE can be derived.
   exit 1;
 
@@ -107,6 +108,3 @@ else
   echo "::error ::There was an error while trying to activate the Unity license."
   exit $UNITY_EXIT_CODE
 fi
-
-# Return to previous working directory
-popd

dist/platforms/ubuntu/steps/return_license.sh

@@ -1,11 +1,6 @@
 #!/usr/bin/env bash
 
-# Run in ACTIVATE_LICENSE_PATH directory
+if [[ -n "$UNITY_LICENSING_SERVER" ]]; then
-echo "Changing to \"$ACTIVATE_LICENSE_PATH\" directory."
-pushd "$ACTIVATE_LICENSE_PATH"
-
-
-if [[ -n "$UNITY_LICENSING_SERVER" ]]; then  #
   #
   # Return any floating license used.
   #
@@ -25,6 +20,3 @@ elif [[ -n "$UNITY_SERIAL" ]]; then
     -password "$UNITY_PASSWORD" \
     -projectPath "/BlankProject"
 fi
-
-# Return to previous working directory
-popd

dist/platforms/windows/activate.ps1

@@ -6,11 +6,64 @@ Write-Output "#        Activating       #"
 Write-Output "###########################"
 Write-Output ""
 
-& "$Env:UNITY_PATH/Editor/Unity.exe" -batchmode -quit -nographics `
+if ( ($null -ne ${env:UNITY_SERIAL}) -and ($null -ne ${env:UNITY_EMAIL}) -and ($null -ne ${env:UNITY_PASSWORD}) )
+{
+  #
+  # SERIAL LICENSE MODE
+  #
+  # This will activate unity, using the serial activation process.
+  #
+  Write-Output "Requesting activation"
+
+  $ACTIVATION_OUTPUT = Start-Process -FilePath "$Env:UNITY_PATH/Editor/Unity.exe" `
+                                     -NoNewWindow `
+                                     -PassThru `
+                                     -ArgumentList  "-batchmode `
+                                                     -quit `
+                                                     -nographics `
                                                      -username $Env:UNITY_EMAIL `
                                                      -password $Env:UNITY_PASSWORD `
                                                      -serial $Env:UNITY_SERIAL `
-                                     -projectPath "c:/BlankProject" `
+                                                     -projectPath c:/BlankProject `
-                                     -logfile - | Out-Host
+                                                     -logfile -"
 
-$ACTIVATION_EXIT_CODE = $LASTEXITCODE
+  # Cache the handle so exit code works properly
+  # https://stackoverflow.com/questions/10262231/obtaining-exitcode-using-start-process-and-waitforexit-instead-of-wait
+  $unityHandle = $ACTIVATION_OUTPUT.Handle
+
+  while ($true) {
+      if ($ACTIVATION_OUTPUT.HasExited) {
+        $ACTIVATION_EXIT_CODE = $ACTIVATION_OUTPUT.ExitCode
+
+        # Display results
+        if ($ACTIVATION_EXIT_CODE -eq 0)
+        {
+            Write-Output "Activation Succeeded"
+        } else
+        {
+            Write-Output "Activation failed, with exit code $ACTIVATION_EXIT_CODE"
+        }
+
+        break
+      }
+
+      Start-Sleep -Seconds 3
+  }
+}
+else
+{
+    #
+    # NO LICENSE ACTIVATION STRATEGY MATCHED
+    #
+    # This will exit since no activation strategies could be matched.
+    #
+    Write-Output "License activation strategy could not be determined."
+    Write-Output ""
+    Write-Output "Visit https://game.ci/docs/github/activation for more"
+    Write-Output "details on how to set up one of the possible activation strategies."
+
+    Write-Output "::error ::No valid license activation strategy could be determined. Make sure to provide UNITY_EMAIL, UNITY_PASSWORD, and either a UNITY_SERIAL \
+or UNITY_LICENSE. See more info at https://game.ci/docs/github/activation"
+
+    $ACTIVATION_EXIT_CODE = 1;
+}

dist/platforms/windows/build.ps1

@@ -137,26 +137,27 @@ $unityArgs = @(
     "-batchmode",
     "-nographics",
     "-silent-crashes",
-    "-projectPath", $Env:UNITY_PROJECT_PATH,
+    "-customBuildName", "`"$Env:BUILD_NAME`"",
-    "-executeMethod", $Env:BUILD_METHOD,
+    "-projectPath", "`"$Env:UNITY_PROJECT_PATH`"",
-    "-buildTarget", $Env:BUILD_TARGET,
+    "-executeMethod", "`"$Env:BUILD_METHOD`"",
-    "-customBuildTarget", $Env:BUILD_TARGET,
+    "-buildTarget", "`"$Env:BUILD_TARGET`"",
-    "-customBuildPath", $Env:CUSTOM_BUILD_PATH,
+    "-customBuildTarget", "`"$Env:BUILD_TARGET`"",
-    "-buildVersion", $Env:VERSION,
+    "-customBuildPath", "`"$Env:CUSTOM_BUILD_PATH`"",
-    "-androidVersionCode", $Env:ANDROID_VERSION_CODE,
+    "-buildVersion", "`"$Env:VERSION`"",
-    "-androidKeystorePass", $Env:ANDROID_KEYSTORE_PASS,
+    "-androidVersionCode", "`"$Env:ANDROID_VERSION_CODE`"",
-    "-androidKeyaliasName", $Env:ANDROID_KEYALIAS_NAME,
+    "-androidKeystorePass", "`"$Env:ANDROID_KEYSTORE_PASS`"",
-    "-androidKeyaliasPass", $Env:ANDROID_KEYALIAS_PASS,
+    "-androidKeyaliasName", "`"$Env:ANDROID_KEYALIAS_NAME`"",
-    "-androidTargetSdkVersion", $Env:ANDROID_TARGET_SDK_VERSION,
+    "-androidKeyaliasPass", "`"$Env:ANDROID_KEYALIAS_PASS`"",
-    "-androidExportType", $Env:ANDROID_EXPORT_TYPE,
+    "-androidTargetSdkVersion", "`"$Env:ANDROID_TARGET_SDK_VERSION`"",
-    "-androidSymbolType", $Env:ANDROID_SYMBOL_TYPE,
+    "-androidExportType", "`"$Env:ANDROID_EXPORT_TYPE`"",
+    "-androidSymbolType", "`"$Env:ANDROID_SYMBOL_TYPE`"",
     "-logfile", "-"
 ) + $customParametersArray
 
 # Remove null items as that will fail the Start-Process call
 $unityArgs = $unityArgs | Where-Object { $_ -ne $null }
 
-$unityProcess = Start-Process -FilePath "$Env:UNITY_PATH\Editor\Unity.exe" `
+$unityProcess = Start-Process -FilePath "$Env:UNITY_PATH/Editor/Unity.exe" `
                               -ArgumentList $unityArgs `
                               -PassThru `
                               -NoNewWindow

dist/platforms/windows/return_license.ps1

@@ -6,9 +6,47 @@ Write-Output "#      Return License     #"
 Write-Output "###########################"
 Write-Output ""
 
-& "$Env:UNITY_PATH\Editor\Unity.exe" -batchmode -quit -nographics `
+if (($null -ne ${env:UNITY_SERIAL}) -and ($null -ne ${env:UNITY_EMAIL}) -and ($null -ne ${env:UNITY_PASSWORD}))
+{
+  #
+  # SERIAL LICENSE MODE
+  #
+  # This will return the license that is currently in use.
+  #
+  $RETURN_LICENSE_OUTPUT = Start-Process -FilePath "$Env:UNITY_PATH/Editor/Unity.exe" `
+                                         -NoNewWindow `
+                                         -PassThru `
+                                         -ArgumentList "-batchmode `
+                                                         -quit `
+                                                         -nographics `
                                                          -username $Env:UNITY_EMAIL `
                                                          -password $Env:UNITY_PASSWORD `
                                                          -returnlicense `
-                                     -projectPath "c:/BlankProject" `
+                                                         -projectPath c:/BlankProject `
-                                     -logfile - | Out-Host
+                                                         -logfile -"
+
+  # Cache the handle so exit code works properly
+  # https://stackoverflow.com/questions/10262231/obtaining-exitcode-using-start-process-and-waitforexit-instead-of-wait
+  $unityHandle = $RETURN_LICENSE_OUTPUT.Handle
+
+  while ($true) {
+      if ($RETURN_LICENSE_OUTPUT.HasExited) {
+        $RETURN_LICENSE_EXIT_CODE = $RETURN_LICENSE_OUTPUT.ExitCode
+
+        # Display results
+        if ($RETURN_LICENSE_EXIT_CODE -eq 0)
+        {
+            Write-Output "License Return Succeeded"
+        } else
+        {
+            Write-Output "License Return failed, with exit code $RETURN_LICENSE_EXIT_CODE"
+            Write-Output "::warning ::License Return failed! If this is a Pro License you might need to manually `
+free the seat in your Unity admin panel or you might run out of seats to activate with."
+        }
+
+        break
+      }
+
+      Start-Sleep -Seconds 3
+  }
+}

dist/platforms/windows/set_gitcredential.ps1

@@ -1,4 +1,4 @@
-if ([string]::IsNullOrEmpty($env:GIT_PRIVATE_TOKEN)) {
+if ($null -eq ${env:GIT_PRIVATE_TOKEN}) {
     Write-Host "GIT_PRIVATE_TOKEN unset skipping"
 }
 else {

src/model/docker.ts

@@ -21,6 +21,9 @@ class Docker {
         break;
       case 'win32':
         runCommand = this.getWindowsCommand(image, parameters);
+        break;
+      default:
+        throw new Error(`Operation system, ${process.platform}, is not supported yet.`);
     }
 
     options.silent = silent;

src/model/image-tag.ts

@@ -168,7 +168,7 @@ class ImageTag {
 
     if (customImage) return customImage;
 
-    return `${image}:${tag}`; // '0' here represents the docker repo version
+    return `${image}:${tag}`;
   }
 }
 

src/model/platform-setup/setup-mac.ts

@@ -187,6 +187,7 @@ class SetupMac {
     process.env.ANDROID_SYMBOL_TYPE = buildParameters.androidSymbolType;
     process.env.CUSTOM_PARAMETERS = buildParameters.customParameters;
     process.env.CHOWN_FILES_TO = buildParameters.chownFilesTo;
+    process.env.MANUAL_EXIT = buildParameters.manualExit.toString();
   }
 }