unity-setup@v1.0.4 (#9)

- improved `version-file` search, and added `None` option when creating new projects or setting `UNITY_PROJECT_PATH` later
RageAgainstThePixel · Aug 12, 2024 · 28e64f6 · 28e64f6
1 parent 4b5453c
commit 28e64f6
Show file tree

Hide file tree

Showing 12 changed files with 75 additions and 61 deletions.
diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml
@@ -47,15 +47,10 @@ jobs:
             modules: mac-server
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/checkout@v4
-        with:
-          repository: RageAgainstThePixel/com.utilities.buildpipeine
-          path: com.utilities.buildpipline
-          ref: development
 
       - uses: ./ # RageAgainstThePixel/unity-setup
         with:
-          version-file: com.utilities.buildpipline/Utilities.BuildPipeline/ProjectSettings/ProjectVersion.txt
+          version-file: 'None'
           unity-version: ${{ matrix.unity-versions }}
           build-targets: ${{ matrix.build-targets }}
           modules: ${{ matrix.modules }}

diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ steps:
 
 | name | description | required |
 | ----------- | ----------- | ----------- |
-| `version-file` | Specify a path to search for the unity project version text file. Useful if there are multiple projects in a single repo. | false |
+| `version-file` | Specify a path to search for the unity project version text file. Useful if there are multiple projects in a single repo. Pass `None` if creating a new project to skip file search. | false |
 | `unity-version` | Specify the Unity version(s) to install. You must include the changeset! i.e `2019.4.13f1 (518737b1de84)`. ***This will override any version specified in the `version-file`!*** | false |
 | `build-targets` | Specify the build targets to install for. Remaps to corresponding module. One or more of `StandaloneWindows64` `WSAPlayer` `StandaloneOSX` `iOS` `StandaloneLinux64` `Android` `Lumin` `WebGL` `VisionOS`. | false |
 | `modules` | Modules to install with the editor. This list can be different per editor version. | false |

diff --git a/action.yml b/action.yml
@@ -1,8 +1,11 @@
 name: 'unity-setup'
-description: 'A GitHub action for setting up the Unity Game Engine for CI/CD workflows.'
+description: A GitHub action for setting up the Unity Game Engine for CI/CD workflows.
+branding:
+  icon: 'download'
+  color: 'blue'
 inputs:
   version-file:
-    description: 'Specify a path to search for the unity project version text file. Useful if there are multiple projects in a single repo.'
+    description: 'Specify a path to search for the unity project version text file. Useful if there are multiple projects in a single repo. Pass `None` if creating a new project to skip file search.'
     required: false
     default: ''
   unity-version:

diff --git a/dist/index.js b/dist/index.js
@@ -34259,20 +34259,22 @@ async function ValidateInputs() {
     if (modules.length == 0) {
         throw Error('No modules or build-targets provided!');
     }
-    const versionFilePath = await getVersionFilePath();
-    core.info(`versionFilePath:\n  > "${versionFilePath}"`);
-    const [unityVersion, changeset] = await getUnityVersionFromFile(versionFilePath);
     const versions = getUnityVersionsFromInput();
-    if (versions.length === 0) {
-        versions.push([unityVersion, changeset]);
+    const versionFilePath = await getVersionFilePath();
+    const unityProjectPath = versionFilePath !== undefined ? path.join(versionFilePath, '..', '..') : undefined;
+    if (versionFilePath) {
+        core.info(`versionFilePath:\n  > "${versionFilePath}"`);
+        core.info(`Unity Project Path:\n  > "${unityProjectPath}"`);
+        const [unityVersion, changeset] = await getUnityVersionFromFile(versionFilePath);
+        if (versions.length === 0) {
+            versions.push([unityVersion, changeset]);
+        }
     }
     versions.sort(([a], [b]) => semver.compare(a, b, true));
     core.info(`Unity Versions:`);
     for (const [version, changeset] of versions) {
         core.info(`  > ${version} (${changeset})`);
     }
-    const unityProjectPath = path.join(versionFilePath, '..', '..');
-    core.info(`Unity Project Path:\n  > "${unityProjectPath}"`);
     return [versions, architecture, modules, unityProjectPath];
 }
 
@@ -34351,31 +34353,36 @@ function getDefaultModules() {
 
 async function getVersionFilePath() {
     let projectVersionPath = core.getInput('version-file');
-    if (projectVersionPath) {
-    } else {
+    if (projectVersionPath !== undefined && projectVersionPath.toLowerCase() === 'none') {
+        return undefined;
+    }
+    if (!projectVersionPath) {
         projectVersionPath = await FindGlobPattern(path.join(process.env.GITHUB_WORKSPACE, '**', 'ProjectVersion.txt'));
     }
-    try {
-        await fs.access(projectVersionPath, fs.constants.R_OK);
-        return projectVersionPath;
-    } catch (error) {
-        core.debug(error);
+    if (projectVersionPath) {
         try {
-            projectVersionPath = path.join(process.env.GITHUB_WORKSPACE, projectVersionPath);
             await fs.access(projectVersionPath, fs.constants.R_OK);
             return projectVersionPath;
         } catch (error) {
-            core.error(error);
+            core.debug(error);
             try {
-                projectVersionPath = await FindGlobPattern(path.join(process.env.GITHUB_WORKSPACE, '**', 'ProjectVersion.txt'));
+                projectVersionPath = path.join(process.env.GITHUB_WORKSPACE, projectVersionPath);
                 await fs.access(projectVersionPath, fs.constants.R_OK);
                 return projectVersionPath;
             } catch (error) {
-                core.debug(error);
+                core.error(error);
+                try {
+                    projectVersionPath = await FindGlobPattern(path.join(process.env.GITHUB_WORKSPACE, '**', 'ProjectVersion.txt'));
+                    await fs.access(projectVersionPath, fs.constants.R_OK);
+                    return projectVersionPath;
+                } catch (error) {
+                    // ignore
+                }
             }
         }
-        throw Error(`Could not find ProjectVersion.txt in ${projectVersionPath}`);
     }
+    core.warning(`Could not find ProjectVersion.txt in ${process.env.GITHUB_WORKSPACE}! UNITY_PROJECT_PATH will not be set.`);
+    return undefined;
 }
 
 function getUnityVersionsFromInput() {
@@ -34723,7 +34730,7 @@ async function execUnityHub(args) {
             });
             break;
         case 'linux': // xvfb-run --auto-servernum "~/Unity Hub/UnityHub.AppImage" --headless help
-            core.info(`[command]"xvfb-run" --auto-servernum "${hubPath}" --headless ${args.join(' ')}`);
+            core.info(`[command]xvfb-run --auto-servernum "${hubPath}" --headless ${args.join(' ')}`);
             await exec.exec('xvfb-run', ['--auto-servernum', hubPath, '--headless', ...args], {
                 listeners: {
                     stdline: (data) => {
@@ -45386,15 +45393,17 @@ const core = __nccwpck_require__(2186);
 const main = async () => {
     try {
         const [versions, architecture, modules, unityProjectPath] = await ValidateInputs();
-        core.exportVariable('UNITY_PROJECT_PATH', unityProjectPath);
+        if (unityProjectPath) {
+            core.exportVariable('UNITY_PROJECT_PATH', unityProjectPath);
+        }
         const unityHubPath = await unityHub.Get();
         core.exportVariable('UNITY_HUB_PATH', unityHubPath);
         const editors = [];
         for (const [version, changeset] of versions) {
             const unityEditorPath = await unityHub.Unity(version, changeset, architecture, modules);
             // for now just export the highest installed version
             core.exportVariable('UNITY_EDITOR_PATH', unityEditorPath);
-            if (modules.includes('android')) {
+            if (modules.includes('android') && unityProjectPath !== undefined) {
                 await CheckAndroidSdkInstalled(unityEditorPath, unityProjectPath);
             }
             editors.push([version, unityEditorPath]);

diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/dist/install-unityhub-windows.ps1 b/dist/install-unityhub-windows.ps1
@@ -6,6 +6,5 @@ Write-Host "Downloading `"$url`" > `"$tempPath`"..."
 $wc.DownloadFile($url, $tempPath)
 Write-Host "`"$tempPath`" /S"
 $process = Start-Process -FilePath $tempPath -ArgumentList '/S' -PassThru -Wait
-Write-Host "Unity Hub installation completed with exit code $process.ExitCode"
 Write-Host "::endgroup::"
-exit $process.ExitCode
+exit [int]$process.ExitCode
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "unity-setup",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "A GitHub action for setting up the Unity Game Engine for CI/CD workflows.",
   "author": "RageAgainstThePixel",
   "license": "MIT",

diff --git a/src/index.js b/src/index.js
@@ -6,15 +6,17 @@ const core = require('@actions/core');
 const main = async () => {
     try {
         const [versions, architecture, modules, unityProjectPath] = await ValidateInputs();
-        core.exportVariable('UNITY_PROJECT_PATH', unityProjectPath);
+        if (unityProjectPath) {
+            core.exportVariable('UNITY_PROJECT_PATH', unityProjectPath);
+        }
         const unityHubPath = await unityHub.Get();
         core.exportVariable('UNITY_HUB_PATH', unityHubPath);
         const editors = [];
         for (const [version, changeset] of versions) {
             const unityEditorPath = await unityHub.Unity(version, changeset, architecture, modules);
             // for now just export the highest installed version
             core.exportVariable('UNITY_EDITOR_PATH', unityEditorPath);
-            if (modules.includes('android')) {
+            if (modules.includes('android') && unityProjectPath !== undefined) {
                 await CheckAndroidSdkInstalled(unityEditorPath, unityProjectPath);
             }
             editors.push([version, unityEditorPath]);

diff --git a/src/inputs.js b/src/inputs.js
@@ -42,20 +42,22 @@ async function ValidateInputs() {
     if (modules.length == 0) {
         throw Error('No modules or build-targets provided!');
     }
-    const versionFilePath = await getVersionFilePath();
-    core.info(`versionFilePath:\n  > "${versionFilePath}"`);
-    const [unityVersion, changeset] = await getUnityVersionFromFile(versionFilePath);
     const versions = getUnityVersionsFromInput();
-    if (versions.length === 0) {
-        versions.push([unityVersion, changeset]);
+    const versionFilePath = await getVersionFilePath();
+    const unityProjectPath = versionFilePath !== undefined ? path.join(versionFilePath, '..', '..') : undefined;
+    if (versionFilePath) {
+        core.info(`versionFilePath:\n  > "${versionFilePath}"`);
+        core.info(`Unity Project Path:\n  > "${unityProjectPath}"`);
+        const [unityVersion, changeset] = await getUnityVersionFromFile(versionFilePath);
+        if (versions.length === 0) {
+            versions.push([unityVersion, changeset]);
+        }
     }
     versions.sort(([a], [b]) => semver.compare(a, b, true));
     core.info(`Unity Versions:`);
     for (const [version, changeset] of versions) {
         core.info(`  > ${version} (${changeset})`);
     }
-    const unityProjectPath = path.join(versionFilePath, '..', '..');
-    core.info(`Unity Project Path:\n  > "${unityProjectPath}"`);
     return [versions, architecture, modules, unityProjectPath];
 }
 
@@ -134,31 +136,36 @@ function getDefaultModules() {
 
 async function getVersionFilePath() {
     let projectVersionPath = core.getInput('version-file');
-    if (projectVersionPath) {
-    } else {
+    if (projectVersionPath !== undefined && projectVersionPath.toLowerCase() === 'none') {
+        return undefined;
+    }
+    if (!projectVersionPath) {
         projectVersionPath = await FindGlobPattern(path.join(process.env.GITHUB_WORKSPACE, '**', 'ProjectVersion.txt'));
     }
-    try {
-        await fs.access(projectVersionPath, fs.constants.R_OK);
-        return projectVersionPath;
-    } catch (error) {
-        core.debug(error);
+    if (projectVersionPath) {
         try {
-            projectVersionPath = path.join(process.env.GITHUB_WORKSPACE, projectVersionPath);
             await fs.access(projectVersionPath, fs.constants.R_OK);
             return projectVersionPath;
         } catch (error) {
-            core.error(error);
+            core.debug(error);
             try {
-                projectVersionPath = await FindGlobPattern(path.join(process.env.GITHUB_WORKSPACE, '**', 'ProjectVersion.txt'));
+                projectVersionPath = path.join(process.env.GITHUB_WORKSPACE, projectVersionPath);
                 await fs.access(projectVersionPath, fs.constants.R_OK);
                 return projectVersionPath;
             } catch (error) {
-                core.debug(error);
+                core.error(error);
+                try {
+                    projectVersionPath = await FindGlobPattern(path.join(process.env.GITHUB_WORKSPACE, '**', 'ProjectVersion.txt'));
+                    await fs.access(projectVersionPath, fs.constants.R_OK);
+                    return projectVersionPath;
+                } catch (error) {
+                    // ignore
+                }
             }
         }
-        throw Error(`Could not find ProjectVersion.txt in ${projectVersionPath}`);
     }
+    core.warning(`Could not find ProjectVersion.txt in ${process.env.GITHUB_WORKSPACE}! UNITY_PROJECT_PATH will not be set.`);
+    return undefined;
 }
 
 function getUnityVersionsFromInput() {

diff --git a/src/install-unityhub-windows.ps1 b/src/install-unityhub-windows.ps1
@@ -6,6 +6,5 @@ Write-Host "Downloading `"$url`" > `"$tempPath`"..."
 $wc.DownloadFile($url, $tempPath)
 Write-Host "`"$tempPath`" /S"
 $process = Start-Process -FilePath $tempPath -ArgumentList '/S' -PassThru -Wait
-Write-Host "Unity Hub installation completed with exit code $process.ExitCode"
 Write-Host "::endgroup::"
-exit $process.ExitCode
+exit [int]$process.ExitCode
diff --git a/src/unity-hub.js b/src/unity-hub.js
@@ -179,7 +179,7 @@ async function execUnityHub(args) {
             });
             break;
         case 'linux': // xvfb-run --auto-servernum "~/Unity Hub/UnityHub.AppImage" --headless help
-            core.info(`[command]"xvfb-run" --auto-servernum "${hubPath}" --headless ${args.join(' ')}`);
+            core.info(`[command]xvfb-run --auto-servernum "${hubPath}" --headless ${args.join(' ')}`);
             await exec.exec('xvfb-run', ['--auto-servernum', hubPath, '--headless', ...args], {
                 listeners: {
                     stdline: (data) => {