feat: add buildProfile parameter (#685)

* feat: add `buildProfile` parameter

add new `buildProfile` action param, which will be passed into
Unity as the `-activeBuildProfile ...` CLI param.

closes https://github.com/game-ci/unity-builder/issues/674

* ci: add tests for Unity 6 and build profiles

dist/default-build-script/Assets/Editor/UnityBuilderAction/Builder.cs

@@ -6,6 +6,9 @@ using UnityBuilderAction.Reporting;
 using UnityBuilderAction.Versioning;
 using UnityEditor;
 using UnityEditor.Build.Reporting;
+#if UNITY_6000_0_OR_NEWER
+using UnityEditor.Build.Profile;
+#endif
 using UnityEngine;
 
 namespace UnityBuilderAction
@@ -17,47 +20,9 @@ namespace UnityBuilderAction
       // Gather values from args
       var options = ArgumentsParser.GetValidatedOptions();
 
-      // Gather values from project
-      var scenes = EditorBuildSettings.scenes.Where(scene => scene.enabled).Select(s => s.path).ToArray();
-      
-      // Get all buildOptions from options
-      BuildOptions buildOptions = BuildOptions.None;
-      foreach (string buildOptionString in Enum.GetNames(typeof(BuildOptions))) {
-        if (options.ContainsKey(buildOptionString)) {
-          BuildOptions buildOptionEnum = (BuildOptions) Enum.Parse(typeof(BuildOptions), buildOptionString);
-          buildOptions |= buildOptionEnum;
-        }
-      }
-
-#if UNITY_2021_2_OR_NEWER
-      // Determine subtarget
-      StandaloneBuildSubtarget buildSubtarget;
-      if (!options.TryGetValue("standaloneBuildSubtarget", out var subtargetValue) || !Enum.TryParse(subtargetValue, out buildSubtarget)) {
-        buildSubtarget = default;
-      }
-#endif
-
-      // Define BuildPlayer Options
-      var buildPlayerOptions = new BuildPlayerOptions {
-        scenes = scenes,
-        locationPathName = options["customBuildPath"],
-        target = (BuildTarget) Enum.Parse(typeof(BuildTarget), options["buildTarget"]),
-        options = buildOptions,
-#if UNITY_2021_2_OR_NEWER
-        subtarget = (int) buildSubtarget
-#endif
-      };
-
       // Set version for this build
       VersionApplicator.SetVersion(options["buildVersion"]);
-      
-      // Apply Android settings
-      if (buildPlayerOptions.target == BuildTarget.Android)
-      {
-        VersionApplicator.SetAndroidVersionCode(options["androidVersionCode"]);
-        AndroidSettings.Apply(options);
-      }
-      
+
       // Execute default AddressableAsset content build, if the package is installed.
       // Version defines would be the best solution here, but Unity 2018 doesn't support that,
       // so we fall back to using reflection instead.
@@ -78,6 +43,72 @@ namespace UnityBuilderAction
         }
       }
 
+      // Get all buildOptions from options
+      BuildOptions buildOptions = BuildOptions.None;
+      foreach (string buildOptionString in Enum.GetNames(typeof(BuildOptions))) {
+        if (options.ContainsKey(buildOptionString)) {
+          BuildOptions buildOptionEnum = (BuildOptions) Enum.Parse(typeof(BuildOptions), buildOptionString);
+          buildOptions |= buildOptionEnum;
+        }
+      }
+
+      // Depending on whether the build is using a build profile, `buildPlayerOptions` will an instance
+      // of either `UnityEditor.BuildPlayerOptions` or `UnityEditor.BuildPlayerWithProfileOptions`
+      dynamic buildPlayerOptions;
+
+      if (options["customBuildProfile"] != "") {
+
+#if UNITY_6000_0_OR_NEWER
+        // Load build profile from Assets folder
+        BuildProfile buildProfile = AssetDatabase.LoadAssetAtPath<BuildProfile>(options["customBuildProfile"]);
+
+        // Set it as active
+        BuildProfile.SetActiveBuildProfile(buildProfile);
+
+        // Define BuildPlayerWithProfileOptions
+        buildPlayerOptions = new BuildPlayerWithProfileOptions {
+            buildProfile = buildProfile,
+            locationPathName = options["customBuildPath"],
+            options = buildOptions,
+        };
+#else
+        throw new Exception("Build profiles are not supported by this version of Unity (" + Application.unityVersion +")");
+#endif
+
+      } else {
+
+        // Gather values from project
+        var scenes = EditorBuildSettings.scenes.Where(scene => scene.enabled).Select(s => s.path).ToArray();
+
+#if UNITY_2021_2_OR_NEWER
+        // Determine subtarget
+        StandaloneBuildSubtarget buildSubtarget;
+        if (!options.TryGetValue("standaloneBuildSubtarget", out var subtargetValue) || !Enum.TryParse(subtargetValue, out buildSubtarget)) {
+          buildSubtarget = default;
+        }
+#endif
+
+        BuildTarget buildTarget = (BuildTarget) Enum.Parse(typeof(BuildTarget), options["buildTarget"]);
+
+        // Define BuildPlayerOptions
+        buildPlayerOptions = new BuildPlayerOptions {
+          scenes = scenes,
+          locationPathName = options["customBuildPath"],
+          target = buildTarget,
+          options = buildOptions,
+#if UNITY_2021_2_OR_NEWER
+          subtarget = (int) buildSubtarget
+#endif
+        };
+
+        // Apply Android settings
+        if (buildTarget == BuildTarget.Android) {
+          VersionApplicator.SetAndroidVersionCode(options["androidVersionCode"]);
+          AndroidSettings.Apply(options);
+        }
+
+      }
+
       // Perform build
       BuildReport buildReport = BuildPipeline.BuildPlayer(buildPlayerOptions);
 

dist/index.js

@@ -297,6 +297,7 @@ class BuildParameters {
             runnerTempPath: input_1.default.runnerTempPath,
             targetPlatform: input_1.default.targetPlatform,
             projectPath: input_1.default.projectPath,
+            buildProfile: input_1.default.buildProfile,
             buildName: input_1.default.buildName,
             buildPath: `${input_1.default.buildsPath}/${input_1.default.targetPlatform}`,
             buildFile,
@@ -6426,6 +6427,7 @@ class ImageEnvironmentFactory {
                 value: process.env.USYM_UPLOAD_AUTH_TOKEN,
             },
             { name: 'PROJECT_PATH', value: parameters.projectPath },
+            { name: 'BUILD_PROFILE', value: parameters.buildProfile },
             { name: 'BUILD_TARGET', value: parameters.targetPlatform },
             { name: 'BUILD_NAME', value: parameters.buildName },
             { name: 'BUILD_PATH', value: parameters.buildPath },
@@ -6968,6 +6970,9 @@ class Input {
         }
         return rawProjectPath.replace(/\/$/, '');
     }
+    static get buildProfile() {
+        return Input.getInput('buildProfile') ?? '';
+    }
     static get runnerTempPath() {
         return Input.getInput('RUNNER_TEMP') ?? '';
     }
@@ -7443,6 +7448,7 @@ class SetupMac {
         process.env.UNITY_LICENSING_SERVER = buildParameters.unityLicensingServer;
         process.env.SKIP_ACTIVATION = buildParameters.skipActivation;
         process.env.PROJECT_PATH = buildParameters.projectPath;
+        process.env.BUILD_PROFILE = buildParameters.buildProfile;
         process.env.BUILD_TARGET = buildParameters.targetPlatform;
         process.env.BUILD_NAME = buildParameters.buildName;
         process.env.BUILD_PATH = buildParameters.buildPath;

dist/platforms/mac/steps/build.sh

@@ -19,6 +19,23 @@ echo "Using build name \"$BUILD_NAME\"."
 
 echo "Using build target \"$BUILD_TARGET\"."
 
+#
+# Display the build profile
+#
+
+if [ -z "$BUILD_PROFILE" ]; then
+  # User has not provided a build profile
+  #
+  echo "Doing a default \"$BUILD_TARGET\" platform build."
+  #
+else
+  # User has provided a path to a build profile `.asset` file
+  #
+  echo "Using build profile \"$BUILD_PROFILE\" relative to \"$UNITY_PROJECT_PATH\"."
+  #
+fi
+
+
 #
 # Display build path and file
 #
@@ -139,6 +156,7 @@ echo ""
   -buildTarget "$BUILD_TARGET" \
   -customBuildTarget "$BUILD_TARGET" \
   -customBuildPath "$CUSTOM_BUILD_PATH" \
+  -customBuildProfile "$BUILD_PROFILE" \
   -executeMethod "$BUILD_METHOD" \
   -buildVersion "$VERSION" \
   -androidVersionCode "$ANDROID_VERSION_CODE" \

dist/platforms/ubuntu/steps/build.sh

@@ -19,6 +19,22 @@ echo "Using build name \"$BUILD_NAME\"."
 
 echo "Using build target \"$BUILD_TARGET\"."
 
+#
+# Display the build profile
+#
+
+if [ -z "$BUILD_PROFILE" ]; then
+  # User has not provided a build profile
+  #
+  echo "Doing a default \"$BUILD_TARGET\" platform build."
+  #
+else
+  # User has provided a path to a build profile `.asset` file
+  #
+  echo "Using build profile \"$BUILD_PROFILE\" relative to \"$UNITY_PROJECT_PATH\"."
+  #
+fi
+
 #
 # Display build path and file
 #
@@ -112,6 +128,7 @@ unity-editor \
   -buildTarget "$BUILD_TARGET" \
   -customBuildTarget "$BUILD_TARGET" \
   -customBuildPath "$CUSTOM_BUILD_PATH" \
+  -customBuildProfile "$BUILD_PROFILE" \
   -executeMethod "$BUILD_METHOD" \
   -buildVersion "$VERSION" \
   -androidVersionCode "$ANDROID_VERSION_CODE" \

dist/platforms/windows/build.ps1

@@ -16,6 +16,25 @@ Write-Output "$('Using build name "')$($Env:BUILD_NAME)$('".')"
 
 Write-Output "$('Using build target "')$($Env:BUILD_TARGET)$('".')"
 
+#
+# Display the build profile
+#
+
+if ($Env:BUILD_PROFILE)
+{
+  # User has provided a path to a build profile `.asset` file
+  #
+  Write-Output "$('Using build profile "')$($Env:BUILD_PROFILE)$('" relative to "')$($Env:UNITY_PROJECT_PATH)$('".')"
+  #
+}
+else
+{
+  # User has not provided a build profile
+  #
+  Write-Output "$('Doing a default "')$($Env:BUILD_TARGET)$('" platform build.')"
+  #
+}
+
 #
 # Display build path and file
 #
@@ -143,6 +162,7 @@ $unityArgs = @(
     "-buildTarget", "`"$Env:BUILD_TARGET`"",
     "-customBuildTarget", "`"$Env:BUILD_TARGET`"",
     "-customBuildPath", "`"$Env:CUSTOM_BUILD_PATH`"",
+    "-customBuildProfile", "`"$Env:BUILD_PROFILE`"",
     "-buildVersion", "`"$Env:VERSION`"",
     "-androidVersionCode", "`"$Env:ANDROID_VERSION_CODE`"",
     "-androidKeystorePass", "`"$Env:ANDROID_KEYSTORE_PASS`"",