Pass buildOptions to the build with customParameters (#190)

* Update Builder.cs

* update of buildOptions

buildOptions should be taken into account for build

* missed name

CONTRIBUTING.md

@@ -19,7 +19,7 @@ When fixing a bug it is fine to submit a pull request right away.
 
 Steps to be performed to submit a pull request:
 
-1. Fork the repository and create your branch from `master`.
+1. Fork the repository and create your branch from `main`.
 2. Run `yarn` in the repository root.
 3. If you've fixed a bug or added code that should be tested, add tests!
 4. Fill out the description, link any related issues and submit your pull request.

README.md

@@ -1,15 +1,12 @@
-<div align="center">
+# Unity - Builder
-<a href="https://github.com/marketplace/actions/unity-builder">
+
-<img width="800" src="media/UnityBuilder-Logo.png" alt="Unity Builder">
+(Not affiliated with Unity Technologies)
-</a>
-<br />
-<br />
 
 GitHub Action to
 [build Unity projects](https://github.com/marketplace/actions/unity-builder)
 for different platforms.
 
-Part of the <a href="https://unity-ci.com"><img height="30" src="media/UnityCI-ReferenceLogo.png" alt="Unity CI"></a> open source project.
+Part of the <a href="https://game.ci">GameCI</a> open source project.
 <br />
 <br />
 
@@ -19,30 +16,28 @@ Part of the <a href="https://unity-ci.com"><img height="30" src="media/UnityCI-R
 <br />
 <br />
 
-</div>
-
 ## How to use
 
 Find the
-[docs](https://unity-ci.com/docs/github)
+[docs](https://game.ci/docs)
-on the Unity CI
+on the GameCI
-[website](https://unity-ci.com/).
+[website](https://game.ci/).
 
 ## Related actions
 
 Visit the
-<a href="https://github.com/webbertakken/unity-actions"><img height="30" src="media/UnityActions-ReferenceLogo.png" alt="Unity Actions"></a>
+GameCI <a href="https://github.com/game-ci/unity-actions">Unity Actions</a>
 status repository for related Actions.
 
 ## Community
 
 Feel free to join us on
-<a href="http://unity-ci.com/discord"><img height="30" src="media/Discord-Logo.svg" alt="Discord" /></a>
+<a href="http://game.ci/discord"><img height="30" src="media/Discord-Logo.svg" alt="Discord" /></a>
 and engage with the community.
 
 ## Contributing
 
-To help out sharpen the documentation, please find the docs [repository](https://github.com/Unity-CI/Website).
+To help improve the documentation, please find the docs [repository](https://github.com/game-ci/documentation).
 
 To contribute to Unity Builder, kindly read the [contribution guide](./CONTRIBUTING.md).
 

action.yml

@@ -4,8 +4,8 @@ description: 'Build Unity projects for different platforms.'
 inputs:
   unityVersion:
     required: false
-    default: ''
+    default: 'auto'
-    description: 'Version of unity to use for building the project.'
+    description: 'Version of unity to use for building the project. Use "auto" to get from your ProjectSettings/ProjectVersion.txt'
   customImage:
     required: false
     default: ''

action/default-build-script/Assets/Editor/Builder.cs

@@ -19,11 +19,21 @@ namespace UnityBuilderAction
       // 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;
+        }
+      }
+
       // Define BuildPlayer Options
-      var buildOptions = new BuildPlayerOptions {
+      var buildPlayerOptions = new BuildPlayerOptions {
         scenes = scenes,
         locationPathName = options["customBuildPath"],
         target = (BuildTarget) Enum.Parse(typeof(BuildTarget), options["buildTarget"]),
+        options = buildOptions
       };
 
       // Set version for this build
@@ -31,11 +41,11 @@ namespace UnityBuilderAction
       VersionApplicator.SetAndroidVersionCode(options["androidVersionCode"]);
       
       // Apply Android settings
-      if (buildOptions.target == BuildTarget.Android)
+      if (buildPlayerOptions.target == BuildTarget.Android)
         AndroidSettings.Apply(options);
 
       // Perform build
-      BuildReport buildReport = BuildPipeline.BuildPlayer(buildOptions);
+      BuildReport buildReport = BuildPipeline.BuildPlayer(buildPlayerOptions);
 
       // Summary
       BuildSummary summary = buildReport.summary;

action/steps/activate.sh

@@ -24,9 +24,7 @@ if [[ -n "$UNITY_LICENSE" ]] || [[ -n "$UNITY_LICENSE_FILE" ]]; then
   fi
 
   # Activate license
-  ACTIVATION_OUTPUT=$(xvfb-run --auto-servernum --server-args='-screen 0 640x480x24' \
+  ACTIVATION_OUTPUT=$(unity-editor \
-    /opt/Unity/Editor/Unity \
-      -batchmode \
       -nographics \
       -logFile /dev/stdout \
       -quit \
@@ -63,15 +61,14 @@ elif [[ -n "$UNITY_SERIAL" && -n "$UNITY_EMAIL" && -n "$UNITY_PASSWORD" ]]; then
   echo "Requesting activation (professional license)"
 
   # Activate license
-  xvfb-run --auto-servernum --server-args='-screen 0 640x480x24' \
+  unity-editor \
-    /opt/Unity/Editor/Unity \
+    -batchmode \
-      -batchmode \
+    -nographics \
-      -nographics \
+    -logFile /dev/stdout \
-      -logFile /dev/stdout \
+    -quit \
-      -quit \
+    -serial "$UNITY_SERIAL" \
-      -serial "$UNITY_SERIAL" \
+    -username "$UNITY_EMAIL" \
-      -username "$UNITY_EMAIL" \
+    -password "$UNITY_PASSWORD"
-      -password "$UNITY_PASSWORD"
 
   # Store the exit code from the verify command
   UNITY_EXIT_CODE=$?

action/steps/build.sh

@@ -68,7 +68,7 @@ fi
 if [[ -z $ANDROID_KEYSTORE_NAME || -z $ANDROID_KEYSTORE_BASE64 ]]; then
   echo "Not creating Android keystore."
 else
-  echo "$ANDROID_KEYSTORE_BASE64" | base64 --decode > "$ANDROID_KEYSTORE_NAME"
+  echo "$ANDROID_KEYSTORE_BASE64" | base64 --decode > "$UNITY_PROJECT_PATH/$ANDROID_KEYSTORE_NAME"
   echo "Created Android keystore."
 fi
 
@@ -108,25 +108,23 @@ echo "#    Building platform    #"
 echo "###########################"
 echo ""
 
-xvfb-run --auto-servernum --server-args='-screen 0 640x480x24' \
+unity-editor \
-  /opt/Unity/Editor/Unity \
+  -nographics \
-    -batchmode \
+  -logfile /dev/stdout \
-    -nographics \
+  -quit \
-    -logfile /dev/stdout \
+  -customBuildName "$BUILD_NAME" \
-    -quit \
+  -projectPath "$UNITY_PROJECT_PATH" \
-    -customBuildName "$BUILD_NAME" \
+  -buildTarget "$BUILD_TARGET" \
-    -projectPath "$UNITY_PROJECT_PATH" \
+  -customBuildTarget "$BUILD_TARGET" \
-    -buildTarget "$BUILD_TARGET" \
+  -customBuildPath "$CUSTOM_BUILD_PATH" \
-    -customBuildTarget "$BUILD_TARGET" \
+  -executeMethod "$BUILD_METHOD" \
-    -customBuildPath "$CUSTOM_BUILD_PATH" \
+  -buildVersion "$VERSION" \
-    -executeMethod "$BUILD_METHOD" \
+  -androidVersionCode "$ANDROID_VERSION_CODE" \
-    -buildVersion "$VERSION" \
+  -androidKeystoreName "$ANDROID_KEYSTORE_NAME" \
-    -androidVersionCode "$ANDROID_VERSION_CODE" \
+  -androidKeystorePass "$ANDROID_KEYSTORE_PASS" \
-    -androidKeystoreName "$ANDROID_KEYSTORE_NAME" \
+  -androidKeyaliasName "$ANDROID_KEYALIAS_NAME" \
-    -androidKeystorePass "$ANDROID_KEYSTORE_PASS" \
+  -androidKeyaliasPass "$ANDROID_KEYALIAS_PASS" \
-    -androidKeyaliasName "$ANDROID_KEYALIAS_NAME" \
+  $CUSTOM_PARAMETERS
-    -androidKeyaliasPass "$ANDROID_KEYALIAS_PASS" \
-    $CUSTOM_PARAMETERS
 
 # Catch exit code
 BUILD_EXIT_CODE=$?

action/steps/return_license.sh

@@ -6,11 +6,9 @@ if [[ -n "$UNITY_SERIAL" ]]; then
   #
   # This will return the license that is currently in use.
   #
-  xvfb-run --auto-servernum --server-args='-screen 0 640x480x24' \
+  unity-editor \
-    /opt/Unity/Editor/Unity \
+    -nographics \
-      -batchmode \
+    -logFile /dev/stdout \
-      -nographics \
+    -quit \
-      -logFile /dev/stdout \
+    -returnlicense
-      -quit \
-      -returnlicense
 fi

src/model/build-parameters.js

@@ -1,6 +1,7 @@
 import AndroidVersioning from './android-versioning';
 import Input from './input';
 import Platform from './platform';
+import UnityVersioning from './unity-versioning';
 import Versioning from './versioning';
 
 class BuildParameters {
@@ -10,6 +11,12 @@ class BuildParameters {
       Input.targetPlatform,
       Input.androidAppBundle,
     );
+
+    const unityVersion = UnityVersioning.determineUnityVersion(
+      Input.projectPath,
+      Input.unityVersion,
+    );
+
     const buildVersion = await Versioning.determineVersion(
       Input.versioningStrategy,
       Input.specifiedVersion,
@@ -21,7 +28,7 @@ class BuildParameters {
     );
 
     return {
-      version: Input.unityVersion,
+      version: unityVersion,
       customImage: Input.customImage,
 
       runnerTempPath: process.env.RUNNER_TEMP,

src/model/build-parameters.test.js

@@ -1,4 +1,5 @@
 import Versioning from './versioning';
+import UnityVersioning from './unity-versioning';
 import BuildParameters from './build-parameters';
 import Input from './input';
 import Platform from './platform';
@@ -7,6 +8,10 @@ const determineVersion = jest
   .spyOn(Versioning, 'determineVersion')
   .mockImplementation(() => '1.3.37');
 
+const determineUnityVersion = jest
+  .spyOn(UnityVersioning, 'determineUnityVersion')
+  .mockImplementation(() => '2019.2.11f1');
+
 afterEach(() => {
   jest.clearAllMocks();
 });
@@ -22,12 +27,9 @@ describe('BuildParameters', () => {
       expect(determineVersion).toHaveBeenCalledTimes(1);
     });
 
-    it('returns the version', async () => {
+    it('determines the unity version only once', async () => {
-      const mockValue = 'someVersion';
+      await BuildParameters.create();
-      jest.spyOn(Input, 'unityVersion', 'get').mockReturnValue(mockValue);
+      expect(determineUnityVersion).toHaveBeenCalledTimes(1);
-      await expect(BuildParameters.create()).resolves.toEqual(
-        expect.objectContaining({ version: mockValue }),
-      );
     });
 
     it('returns the android version code with provided input', async () => {

src/model/image-tag.js

@@ -1,11 +1,11 @@
-import { has, get, trimEnd, trimStart } from 'lodash-es';
+import { trimEnd, trimStart } from 'lodash-es';
 import Platform from './platform';
 
 class ImageTag {
   constructor(imageProperties) {
     const {
-      repository = 'gableroux',
+      repository = 'unityci',
-      name = 'unity3d',
+      name = 'editor',
       version = '2019.2.11f1',
       platform,
       customImage,
@@ -15,15 +15,7 @@ class ImageTag {
       throw new Error(`Invalid version "${version}".`);
     }
 
-    if (!has(ImageTag.targetPlatformToImageSuffixMap, platform)) {
+    const builderPlatform = ImageTag.getTargetPlatformToImageSuffixMap(platform, version);
-      throw new Error(`Platform "${platform}" is currently not supported.`);
-    }
-
-    const builderPlatform = get(
-      ImageTag.targetPlatformToImageSuffixMap,
-      platform,
-      ImageTag.imageSuffixes.generic,
-    );
 
     Object.assign(this, { repository, name, version, platform, builderPlatform, customImage });
   }
@@ -36,40 +28,81 @@ class ImageTag {
     return {
       generic: '',
       webgl: 'webgl',
-      mac: 'mac',
+      mac: 'mac-mono',
-      windows: 'windows',
+      windows: 'windows-mono',
+      linux: 'base',
+      linuxIl2cpp: 'linux-il2cpp',
       android: 'android',
       ios: 'ios',
       facebook: 'facebook',
     };
   }
 
-  static get targetPlatformToImageSuffixMap() {
+  static getTargetPlatformToImageSuffixMap(platform, version) {
-    const { generic, webgl, mac, windows, android, ios, facebook } = ImageTag.imageSuffixes;
+    const {
+      generic,
+      webgl,
+      mac,
+      windows,
+      linux,
+      linuxIl2cpp,
+      android,
+      ios,
+      facebook,
+    } = ImageTag.imageSuffixes;
 
+    const [major, minor] = version.split('.').map((digit) => Number(digit));
     // @see: https://docs.unity3d.com/ScriptReference/BuildTarget.html
-    return {
+    switch (platform) {
-      [Platform.types.StandaloneOSX]: mac,
+      case Platform.types.StandaloneOSX:
-      [Platform.types.StandaloneWindows]: windows,
+        return mac;
-      [Platform.types.StandaloneWindows64]: windows,
+      case Platform.types.StandaloneWindows:
-      [Platform.types.StandaloneLinux64]: windows,
+        return windows;
-      [Platform.types.iOS]: ios,
+      case Platform.types.StandaloneWindows64:
-      [Platform.types.Android]: android,
+        return windows;
-      [Platform.types.WebGL]: webgl,
+      case Platform.types.StandaloneLinux64: {
-      [Platform.types.WSAPlayer]: windows,
+        // Unity versions before 2019.3 do not support il2cpp
-      [Platform.types.PS4]: windows,
+        if (major >= 2020 || (major === 2019 && minor >= 3)) {
-      [Platform.types.XboxOne]: windows,
+          return linuxIl2cpp;
-      [Platform.types.tvOS]: windows,
+        }
-      [Platform.types.Switch]: windows,
+        return linux;
+      }
+      case Platform.types.iOS:
+        return ios;
+      case Platform.types.Android:
+        return android;
+      case Platform.types.WebGL:
+        return webgl;
+      case Platform.types.WSAPlayer:
+        return windows;
+      case Platform.types.PS4:
+        return windows;
+      case Platform.types.XboxOne:
+        return windows;
+      case Platform.types.tvOS:
+        return windows;
+      case Platform.types.Switch:
+        return windows;
       // Unsupported
-      [Platform.types.Lumin]: windows,
+      case Platform.types.Lumin:
-      [Platform.types.BJM]: windows,
+        return windows;
-      [Platform.types.Stadia]: windows,
+      case Platform.types.BJM:
-      [Platform.types.Facebook]: facebook,
+        return windows;
-      [Platform.types.NoTarget]: generic,
+      case Platform.types.Stadia:
+        return windows;
+      case Platform.types.Facebook:
+        return facebook;
+      case Platform.types.NoTarget:
+        return generic;
+
       // Test specific
-      [Platform.types.Test]: generic,
+      case Platform.types.Test:
-    };
+        return generic;
+      default:
+        throw new Error(`
+          Platform must be one of the ones described in the documentation.
+          "${platform}" is currently not supported.`);
+    }
   }
 
   get tag() {
@@ -87,7 +120,7 @@ class ImageTag {
       return this.customImage;
     }
 
-    return `${image}:${tag}`;
+    return `${image}:${tag}-0`; // '0' here represents the docker repo version
   }
 }
 

src/model/image-tag.test.js

@@ -1,6 +1,6 @@
 import ImageTag from './image-tag';
 
-describe('UnityImageVersion', () => {
+describe('ImageTag', () => {
   const some = {
     repository: 'test1',
     name: 'test2',
@@ -10,9 +10,9 @@ describe('UnityImageVersion', () => {
   };
 
   const defaults = {
-    repository: 'gableroux',
+    repository: 'unityci',
-    name: 'unity3d',
+    name: 'editor',
-    image: 'gableroux/unity3d',
+    image: 'unityci/editor',
   };
 
   describe('constructor', () => {
@@ -49,7 +49,7 @@ describe('UnityImageVersion', () => {
     it('returns the correct version', () => {
       const image = new ImageTag({ version: '2099.1.1111', platform: some.platform });
 
-      expect(image.toString()).toStrictEqual(`${defaults.image}:2099.1.1111`);
+      expect(image.toString()).toStrictEqual(`${defaults.image}:2099.1.1111-0`);
     });
     it('returns customImage if given', () => {
       const image = new ImageTag({
@@ -64,13 +64,13 @@ describe('UnityImageVersion', () => {
     it('returns the specific build platform', () => {
       const image = new ImageTag({ version: '2019.2.11f1', platform: 'WebGL' });
 
-      expect(image.toString()).toStrictEqual(`${defaults.image}:2019.2.11f1-webgl`);
+      expect(image.toString()).toStrictEqual(`${defaults.image}:2019.2.11f1-webgl-0`);
     });
 
     it('returns no specific build platform for generic targetPlatforms', () => {
       const image = new ImageTag({ platform: 'NoTarget' });
 
-      expect(image.toString()).toStrictEqual(`${defaults.image}:2019.2.11f1`);
+      expect(image.toString()).toStrictEqual(`${defaults.image}:2019.2.11f1-0`);
     });
   });
 });

src/model/input.js

@@ -9,7 +9,7 @@ const core = require('@actions/core');
  */
 class Input {
   static get unityVersion() {
-    return core.getInput('unityVersion');
+    return core.getInput('unityVersion') || 'auto';
   }
 
   static get customImage() {

src/model/input.test.js

@@ -10,7 +10,7 @@ afterEach(() => {
 describe('Input', () => {
   describe('unityVersion', () => {
     it('returns the default value', () => {
-      expect(Input.unityVersion).toStrictEqual('');
+      expect(Input.unityVersion).toStrictEqual('auto');
     });
 
     it('takes input from the users workflow', () => {

src/model/unity-versioning.js

@@ -0,0 +1,33 @@
+import * as core from '@actions/core';
+import * as fs from 'fs';
+import * as path from 'path';
+
+export default class UnityVersioning {
+  static get versionPattern() {
+    return /20\d{2}\.\d\.\w{3,4}|3/;
+  }
+
+  static determineUnityVersion(projectPath, unityVersion) {
+    if (unityVersion === 'auto') {
+      return UnityVersioning.read(projectPath);
+    }
+    return unityVersion;
+  }
+
+  static read(projectPath) {
+    const filePath = path.join(projectPath, 'ProjectSettings', 'ProjectVersion.txt');
+    if (!fs.existsSync(filePath)) {
+      core.warning(`Could not find "${filePath}", keeping unityVersion as "auto"`);
+      return 'auto';
+    }
+    return UnityVersioning.parse(fs.readFileSync(filePath, 'utf8'));
+  }
+
+  static parse(projectVersionTxt) {
+    const matches = projectVersionTxt.match(UnityVersioning.versionPattern);
+    if (!matches || matches.length === 0) {
+      throw new Error(`Failed to parse version from "${projectVersionTxt}".`);
+    }
+    return matches[0];
+  }
+}

src/model/unity-versioning.test.js

@@ -0,0 +1,35 @@
+import UnityVersioning from './unity-versioning';
+
+describe('Unity Versioning', () => {
+  describe('parse', () => {
+    it('throws for empty string', () => {
+      expect(() => UnityVersioning.parse('')).toThrow(Error);
+    });
+
+    it('parses from ProjectVersion.txt', () => {
+      const projectVersionContents = `m_EditorVersion: 2019.2.11f1
+      m_EditorVersionWithRevision: 2019.2.11f1 (5f859a4cfee5)`;
+      expect(UnityVersioning.parse(projectVersionContents)).toBe('2019.2.11f1');
+    });
+  });
+
+  describe('read', () => {
+    it('does not throw', () => {
+      expect(() => UnityVersioning.read('')).not.toThrow();
+    });
+
+    it('reads from test-project', () => {
+      expect(UnityVersioning.read('./test-project')).toBe('2019.2.11f1');
+    });
+  });
+
+  describe('determineUnityVersion', () => {
+    it('defaults to parsed version', () => {
+      expect(UnityVersioning.determineUnityVersion('./test-project', 'auto')).toBe('2019.2.11f1');
+    });
+
+    it('use specified unityVersion', () => {
+      expect(UnityVersioning.determineUnityVersion('./test-project', '1.2.3')).toBe('1.2.3');
+    });
+  });
+});