Add Android signing option to build task (#269)

FejZa · web-flow · commit 44b72bffe90e · 2024-12-10T09:01:39.000+01:00
* Remove deprecation

* Align UnityCMD input options with other tasks and remove deprecation

* Revert extension version change until ready for release

* Organize input variables into logical groups

* Add keystore input options

* Map and pass new inputs

* Add missing changelog

* Update README

* Add PR trigger

* Update gitignore

* Fix tests

* Update dep
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ Documentation for the extension can be found at [www.unitydevops.com](https://ww
 
 | Branch      | Description                                                                                                                                                                        | Status                                                                                                                                                     |
 | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| main        | The main branch is build and deployed to the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=DinomiteStudios.64e90d50-a9c0-11e8-a356-d3eab7857116) | [![Build Status](https://dev.azure.com/dinomite/Unity%20Tools%20for%20Azure%20DevOps/_apis/build/status%2FDinomite-Studios.unity-azure-pipelines-tasks?branchName=main)](https://dev.azure.com/dinomite/Unity%20Tools%20for%20Azure%20DevOps/_build/latest?definitionId=51&branchName=main)        |
+| main        | The main branch is build and deployed to the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=DinomiteStudios.64e90d50-a9c0-11e8-a356-d3eab7857116) | [![Build, Test and Deploy](https://github.com/Dinomite-Studios/unity-azure-pipelines-tasks/actions/workflows/build-test-deploy.yml/badge.svg)](https://github.com/Dinomite-Studios/unity-azure-pipelines-tasks/actions/workflows/build-test-deploy.yml)        |
 
 ## Contributions
 
diff --git a/Tasks/UnityBuild/UnityBuildV3/CHANGELOG.md b/Tasks/UnityBuild/UnityBuildV3/CHANGELOG.md
@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.2.5]
+
+### Added
+
+- Add visionOS build target
+- Add configuration options to sign an Android build using a keystore
+
+### Changed
+
+- Improved input variables grouping in visual editor
+- The output variable now points directly to the genereated lot file instead of the folder containing it. This is to avoid uploading log files from previous runs if there happen to be multiple log files in the log directory
+- Optimized editor version selection UX. Instead of using the project's version if the version input variable is empty we use a dropdown element that offers two options. Either to use the project's Unity version or specify one, which will only then show a input textbox for entering a custom Unity version. This is aligned with the other tasks for a consistent user experience
+
 ## [3.2.4]
 
 ### Fixed
diff --git a/Tasks/UnityBuild/UnityBuildV3/package.json b/Tasks/UnityBuild/UnityBuildV3/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@dinomite-studios/unity-build-task",
-  "version": "3.2.4",
+  "version": "3.2.5",
   "description": "An Azure Pipelines task to build Unity projects.",
   "main": "unity-build.js",
   "scripts": {
diff --git a/Tasks/UnityBuild/UnityBuildV3/task.json b/Tasks/UnityBuild/UnityBuildV3/task.json
@@ -13,46 +13,36 @@
   "version": {
     "Major": 3,
     "Minor": 2,
-    "Patch": 4
+    "Patch": 5
   },
   "releaseNotes": "[Full Changelog](https://github.com/Dinomite-Studios/unity-azure-pipelines-tasks/blob/master/Tasks/UnityBuild/UnityBuildV3/CHANGELOG.md)",
   "minimumAgentVersion": "2.144.0",
   "instanceNameFormat": "Unity Build $(buildTarget)",
-  "groups": [],
-  "inputs": [
+  "groups": [
     {
-      "name": "buildTarget",
-      "type": "pickList",
-      "label": "Build target",
-      "defaultValue": "standalone",
-      "helpMarkDown": "Build platform to build the Unity project for.",
-      "options": {
-        "standalone": "Standalone (agent-based)",
-        "Win": "Windows Standalone (32-bit)",
-        "Win64": "Windows Standalone (64-bit)",
-        "OSXUniversal": "macOS Standalone",
-        "Linux": "Linux Standalone (32-bit)",
-        "Linux64": "Linux Standalone (64-bit)",
-        "LinuxUniversal": "Linux Standalone (universal)",
-        "iOS": "iOS",
-        "Android": "Android",
-        "Web": "Web",
-        "WebStreamed": "Web Streamed",
-        "WebGL": "WebGL",
-        "XboxOne": "Xbox One",
-        "PS4": "PS4",
-        "WindowsStoreApps": "Windows Store Apps",
-        "Switch": "Switch",
-        "N3DS": "N3DS",
-        "tvOS": "tvOS"
-      }
+      "name": "general",
+      "displayName": "General",
+      "isExpanded": true
     },
+    {
+      "name": "build",
+      "displayName": "Build",
+      "isExpanded": true
+    },
+    {
+      "name": "platform",
+      "displayName": "Platform",
+      "isExpanded": true
+    }
+  ],
+  "inputs": [
     {
       "name": "unityEditorsPathMode",
       "type": "pickList",
       "label": "Unity editors location",
       "defaultValue": "default",
       "helpMarkDown": "Define where to look for Unity installations on the agent.",
+      "groupName": "general",
       "options": {
         "default": "Default (recommended)",
         "environmentVariable": "Use UNITYHUB_EDITORS_FOLDER_LOCATION environment variable on agent",
@@ -64,24 +54,18 @@
       "type": "string",
       "label": "Editors folder location",
       "defaultValue": "",
+      "groupName": "general",
       "required": true,
       "visibleRule": "unityEditorsPathMode == specify",
       "helpMarkDown": "Specify where to look for Unity Editor versions on the agent."
     },
-    {
-      "name": "unityProjectPath",
-      "type": "filePath",
-      "label": "Unity project path",
-      "defaultValue": "",
-      "required": false,
-      "helpMarkDown": "(Optional) Enter the directory path to the Unity project. If no value is entered, the root of the repository will be used."
-    },
     {
       "name": "versionSelectionMode",
       "type": "pickList",
-      "label": "Unity version to build with",
-      "required": true,
-      "helpMarkDown": "Select which Unity version to build the project with. You can either use the project's version or specify a version yourself.",
+      "label": "Unity version",
+      "groupName": "general",
+      "required": false,
+      "helpMarkDown": "Select which Unity version to run the task with.",
       "defaultValue": "project",
       "options": {
         "project": "Project Version",
@@ -92,17 +76,57 @@
       "name": "version",
       "type": "string",
       "label": "Version",
+      "groupName": "general",
       "defaultValue": "",
       "required": true,
-      "helpMarkDown": "The Unity editor version to activate the license with, e.g. value: `2022.2.1f1`.",
+      "helpMarkDown": "Select which Unity version to run the task with, e.g. value: `2022.2.1f1`.",
       "visibleRule": "versionSelectionMode == specify"
     },
+    {
+      "name": "unityProjectPath",
+      "type": "filePath",
+      "label": "Unity project path",
+      "groupName": "general",
+      "defaultValue": "",
+      "required": false,
+      "helpMarkDown": "(Optional) Enter the path to the Unity project within the repository. If no value is entered, the root of the repository will be used."
+    },
+    {
+      "name": "buildTarget",
+      "type": "pickList",
+      "label": "Build target",
+      "defaultValue": "standalone",
+      "helpMarkDown": "Build platform to build the Unity project for.",
+      "groupName": "build",
+      "options": {
+        "standalone": "Standalone (agent-based)",
+        "Win": "Windows Standalone (32-bit)",
+        "Win64": "Windows Standalone (64-bit)",
+        "OSXUniversal": "macOS Standalone",
+        "Linux": "Linux Standalone (32-bit)",
+        "Linux64": "Linux Standalone (64-bit)",
+        "LinuxUniversal": "Linux Standalone (universal)",
+        "iOS": "iOS",
+        "Android": "Android",
+        "Web": "Web",
+        "WebStreamed": "Web Streamed",
+        "WebGL": "WebGL",
+        "XboxOne": "Xbox One",
+        "PS4": "PS4",
+        "WindowsStoreApps": "Windows Store Apps",
+        "Switch": "Switch",
+        "N3DS": "N3DS",
+        "tvOS": "tvOS",
+        "visionos": "visionOS"
+      }
+    },
     {
       "name": "buildScriptType",
       "type": "radio",
       "label": "Build script type",
       "defaultValue": "default",
       "helpMarkDown": "Build script type: Use `Default` to use a built-in simple script which will perform a build without additional options. Use `Existing` if you already have a build script in your source and only need to specify the method to execute on build. Or use `Inline` to define the script inline, please make sure it's valid C#.",
+      "groupName": "build",
       "options": {
         "default": "Default",
         "existing": "Existing",
@@ -114,6 +138,7 @@
       "type": "filePath",
       "helpMarkDown": "Specify the build output path relative to the repository root or fully qualified.",
       "label": "Output path",
+      "groupName": "build",
       "required": true,
       "defaultValue": "$(Build.BinariesDirectory)",
       "visibleRule": "buildScriptType = default"
@@ -122,16 +147,19 @@
       "name": "outputFileName",
       "type": "string",
       "label": "Output filename",
+      "groupName": "build",
       "helpMarkDown": "Enter the output filename to be used when constructing the platform-appropriate output. For instance, if you want the output to be 'thegame.exe' on Windows Standalone, enter 'thegame'",
       "required": true,
-      "defaultValue": "drop"
+      "defaultValue": "drop",
+      "visibleRule": "buildScriptType = default"
     },
     {
       "name": "inlineBuildScript",
       "type": "multiLine",
       "label": "Inline build script",
       "visibleRule": "buildScriptType = inline",
       "required": true,
+      "groupName": "build",
       "defaultValue": "/* Write your C# build script here. Define a class and make sure to define a public static method to execute for the build. You'll want to verify your script actually works on your local computer.\n\nExample:\npublic class MyClass {\npublic static void PerformBuild() {\n...\n}\n}\n */",
       "properties": {
         "resizable": "true",
@@ -144,6 +172,7 @@
       "name": "scriptExecuteMethod",
       "type": "string",
       "label": "Build script execute method",
+      "groupName": "build",
       "visibleRule": "buildScriptType = inline || buildScriptType = existing",
       "required": true,
       "defaultValue": "",
@@ -153,14 +182,65 @@
       "name": "additionalCmdArgs",
       "type": "string",
       "label": "Command line arguments",
+      "groupName": "build",
       "defaultValue": "",
       "helpMarkDown": "(Optional) Specify additional command line arguments, see the [documentation](https://docs.unity3d.com/Manual/CommandLineArguments.html) for more info."
+    },
+    {
+      "name": "signAppBundle",
+      "type": "boolean",
+      "label": "Sign APK / app bundle",
+      "groupName": "platform",
+      "defaultValue": true,
+      "required": false,
+      "helpMarkDown": "Whether to sign the produced APK / app bundle using a custom keystore.",
+      "visibleRule": "buildTarget == Android && buildScriptType == default"
+    },
+    {
+      "name": "keystoreName",
+      "type": "filePath",
+      "helpMarkDown": "Android keystore name / file path.",
+      "label": "Keystore file path",
+      "groupName": "platform",
+      "required": true,
+      "defaultValue": "",
+      "visibleRule": "buildTarget == Android && signAppBundle == true && buildScriptType == default"
+    },
+    {
+      "name": "keystorePass",
+      "type": "string",
+      "label": "Keystore password",
+      "groupName": "platform",
+      "helpMarkDown": "Android keystore password.",
+      "required": true,
+      "defaultValue": "",
+      "visibleRule": "buildTarget == Android && signAppBundle == true && buildScriptType == default"
+    },
+    {
+      "name": "keystoreAliasName",
+      "type": "string",
+      "label": "Keystore alias name",
+      "groupName": "platform",
+      "helpMarkDown": "Android key alias name.",
+      "required": true,
+      "defaultValue": "",
+      "visibleRule": "buildTarget == Android && signAppBundle == true && buildScriptType == default"
+    },
+    {
+      "name": "keystoreAliasPass",
+      "type": "string",
+      "label": "Keystore alias password",
+      "groupName": "platform",
+      "helpMarkDown": "Password for the key used for signing an Android application. If left empty, the keystore main password is assumed.",
+      "required": false,
+      "defaultValue": "",
+      "visibleRule": "buildTarget == Android && signAppBundle == true && buildScriptType == default"
     }
   ],
   "outputVariables": [
     {
-      "name": "logsOutputPath",
-      "description": "Path to the Unity editor log files generated."
+      "name": "editorLogFilePath",
+      "description": "Specifies the location of the editor log file generated."
     }
   ],
   "execution": {
diff --git a/Tasks/UnityBuild/UnityBuildV3/unity-build.ts b/Tasks/UnityBuild/UnityBuildV3/unity-build.ts
@@ -16,10 +16,22 @@ const buildTargetInputVariableName = 'buildTarget';
 const outputPathInputVariableName = 'outputPath';
 const unityProjectPathInputVariableName = 'unityProjectPath';
 const versionInputVariableName = 'version';
+const buildScriptTypeInputVariableName = 'buildScriptType';
 const unityEditorsPathModeInputVariableName = 'unityEditorsPathMode';
+const inlineBuildScriptInputVariableName = 'inlineBuildScript';
+const scriptExecuteMethodInputVariableName = 'scriptExecuteMethod';
+const additionalCmdArgsInputVariableName = 'additionalCmdArgs';
 const customUnityEditorsPathInputVariableName = 'customUnityEditorsPath';
 const cleanBuildInputVariableName = 'Build.Repository.Clean';
-const versionSelectionModeVariableName = "versionSelectionMode";
+const versionSelectionModeVariableName = 'versionSelectionMode';
+const signAppBundleInputVariableName = 'signAppBundle';
+const keystoreNameInputVariableName = 'keystoreName';
+const keystorePassInputVariableName = 'keystorePass';
+const keystoreAliasNameInputVariableName = 'keystoreAliasName';
+const keystoreAliasPassInputVariableName = 'keystoreAliasPass';
+
+// Output variables.
+const editorLogFilePathOutputVariableName = 'editorLogFilePath';
 
 async function run() {
     try {
@@ -54,8 +66,11 @@ async function run() {
 
         const unityExecutablePath = UnityPathTools.getUnityExecutableFullPath(unityEditorsPath, unityVersion.info!);
         const cleanBuild = tl.getVariable(cleanBuildInputVariableName);
+
+        // Set output variable values.
         const logFilesDirectory = path.join(tl.getVariable('Agent.TempDirectory')!, 'Logs');
         const logFilePath = path.join(logFilesDirectory, `UnityBuildLog_${Utilities.getLogFileNameTimeStamp()}.log`);
+        tl.setVariable(editorLogFilePathOutputVariableName, logFilePath);
 
         // If clean was specified by the user, delete the existing output directory, if it exists
         if (cleanBuild === 'true') {
@@ -73,13 +88,13 @@ async function run() {
             .arg('-projectPath').arg(projectPath)
             .arg('-logfile').arg(logFilePath);
 
-        const additionalArgs = tl.getInput('additionalCmdArgs') ?? '';
+        const additionalArgs = tl.getInput(additionalCmdArgsInputVariableName) ?? '';
         if (additionalArgs !== '') {
             unityCmd.line(additionalArgs);
         }
 
         // Perform setup depending on build script type selected
-        const buildScriptType = tl.getInput('buildScriptType') ?? 'default';
+        const buildScriptType = tl.getInput(buildScriptTypeInputVariableName) ?? 'default';
 
         if (buildScriptType === 'default') {
             // When using default build scripts we rely on a Utility package being installed to the project via the Unity Package Manager.
@@ -88,20 +103,32 @@ async function run() {
             unityCmd.arg('-executeMethod').arg('AzurePipelinesBuild.PerformBuild');
             unityCmd.arg('-outputFileName').arg(outputFileName);
             unityCmd.arg('-outputPath').arg(outputPath);
+
+            if (tl.getBoolInput(signAppBundleInputVariableName)) {
+                unityCmd.arg('-keystoreName').arg(tl.getPathInput(keystoreNameInputVariableName) ?? '');
+                unityCmd.arg('-keystorePass').arg(tl.getInput(keystorePassInputVariableName) ?? '');
+                unityCmd.arg('-keystoreAliasName').arg(tl.getInput(keystoreAliasNameInputVariableName) ?? '');
+
+                // The alias password is optional and should only be passed, if not empty or undefined.
+                const keystoreAliasPass = tl.getInput(keystoreAliasPassInputVariableName) ?? '';
+                if (keystoreAliasPass) {
+                    unityCmd.arg('-keystoreAliasPass').arg(keystoreAliasPass);
+                }
+            }
         } else if (buildScriptType === 'inline') {
             // Create a C# script file in a Editor folder at the root Assets directory level. Then write
             // the default or the user's script into it. Unity will then compile it on launch and make sure it's available.
             const projectAssetsEditorFolderPath = path.join(`${projectPath}`, 'Assets', 'Editor');
             tl.mkdirP(projectAssetsEditorFolderPath);
             tl.cd(projectAssetsEditorFolderPath);
-            tl.writeFile('AzureDevOps.cs', tl.getInput('inlineBuildScript')!);
+            tl.writeFile('AzureDevOps.cs', tl.getInput(inlineBuildScriptInputVariableName)!);
             tl.cd(projectPath);
 
             // Tell Unity which method to execute for build.
-            unityCmd.arg('-executeMethod').arg(tl.getInput('scriptExecuteMethod')!);
+            unityCmd.arg('-executeMethod').arg(tl.getInput(scriptExecuteMethodInputVariableName)!);
         } else if (buildScriptType === 'existing') {
             // If the user already has an existing build script we only need the method to execute.
-            unityCmd.arg('-executeMethod').arg(tl.getInput('scriptExecuteMethod')!).arg('-quit');
+            unityCmd.arg('-executeMethod').arg(tl.getInput(scriptExecuteMethodInputVariableName)!).arg('-quit');
         } else {
             throw `Unsupported build script type ${buildScriptType}`
         }
diff --git a/Tasks/UnityGetProjectVersion/UnityGetProjectVersionV1/package-lock.json b/Tasks/UnityGetProjectVersion/UnityGetProjectVersionV1/package-lock.json

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@dinomite-studios/unity-build-task",`
`3`		`- "version": "3.2.4",`
	`3`	`+ "version": "3.2.5",`
`4`	`4`	`"description": "An Azure Pipelines task to build Unity projects.",`
`5`	`5`	`"main": "unity-build.js",`
`6`	`6`	`"scripts": {`