Update readme for 0.9 (custom parameters)

.editorconfig

@@ -14,5 +14,8 @@ trim_trailing_whitespace = true
 max_line_length = off
 trim_trailing_whitespace = false
 
+[*.{yml,yaml}]
+max_line_length = off
+
 [COMMIT_EDITMSG]
-max_line_length = 0
+max_line_length = off

.github/workflows/main.yml

@@ -8,6 +8,20 @@ env:
   UNITY_LICENSE: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n    <License id=\"Terms\">\n        <MachineBindings>\n            <Binding Key=\"1\" Value=\"d39b8e2f4d364b2e98b06afa0c6e08c5\"/>\n            <Binding Key=\"2\" Value=\"d39b8e2f4d364b2e98b06afa0c6e08c5\"/>\n        </MachineBindings>\n        <MachineID Value=\"Xxo1ZKbdPu/IATrc0mPBYANJFF0=\"/>\n        <SerialHash Value=\"1efd68fa935192b6090ac03c77d289a9f588c55a\"/>\n        <Features>\n            <Feature Value=\"33\"/>\n            <Feature Value=\"1\"/>\n            <Feature Value=\"12\"/>\n            <Feature Value=\"2\"/>\n            <Feature Value=\"24\"/>\n            <Feature Value=\"3\"/>\n            <Feature Value=\"36\"/>\n            <Feature Value=\"17\"/>\n            <Feature Value=\"19\"/>\n            <Feature Value=\"62\"/>\n        </Features>\n        <DeveloperData Value=\"AQAAAEY0LUg2WFMtUE00NS1SM0M4LUUyWlotWkdWOA==\"/>\n        <SerialMasked Value=\"F4-H6XS-PM45-R3C8-E2ZZ-XXXX\"/>\n        <StartDate Value=\"2018-05-02T00:00:00\"/>\n        <UpdateDate Value=\"2019-11-25T18:23:38\"/>\n        <InitialActivationDate Value=\"2018-05-02T14:21:28\"/>\n        <LicenseVersion Value=\"6.x\"/>\n        <ClientProvidedVersion Value=\"2019.2.11f1\"/>\n        <AlwaysOnline Value=\"false\"/>\n        <Entitlements>\n            <Entitlement Ns=\"unity_editor\" Tag=\"UnityPersonal\" Type=\"EDITOR\" ValidTo=\"9999-12-31T00:00:00\"/>\n        </Entitlements>\n    </License>\n<Signature xmlns=\"http://www.w3.org/2000/09/xmldsig#\"><SignedInfo><CanonicalizationMethod Algorithm=\"http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments\"/><SignatureMethod Algorithm=\"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"/><Reference URI=\"#Terms\"><Transforms><Transform Algorithm=\"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"/></Transforms><DigestMethod Algorithm=\"http://www.w3.org/2000/09/xmldsig#sha1\"/><DigestValue>JHdOBFmBNq2H8BrGFzir/StLoYo=</DigestValue></Reference></SignedInfo><SignatureValue>aENLHd37a51RtP2/g7YU0Pexf5mx0/ENXYGtrPzqwZ8NQt2AsSdxGnl0CUB45/GuNXfJVDt2HWot\ncNYZB2OylVBn1WHQbKZlPmm8gEAMz0MYbr4Isb5i5buryBrZlmbEOjnRI+pEg1CBwlgMo6xdtjjE\n/d7cC293QIUO91kdzRXftYou1dNaUyuPL9ZH65vdB2pDXGRNxgUVD+GnnqZA7b5L2HXqNQclcWAK\n5Yd1BeF3VzR1iLw9G/SmH5oOhnpXSmqbL4qk7LVP2/mgXpFk5kP4X8VC3z47obNhBIGq40dwWyEe\nUYk5/nRAOkZawDT+tcu96e06gPC9Cxk5PdbRbA==</SignatureValue></Signature></root>"
 
 jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+      - run: yarn
+      - run: yarn lint
+      - run: yarn test
+      - run: yarn build || { echo "build command should always succeed" ; exit 61; }
+      - run: yarn build --quiet && git diff --quiet builder || { echo "builder should be auto generated" ; exit 62; }
+
   buildForAllPlatforms:
     name: Build for ${{ matrix.targetPlatform }} on version ${{ matrix.unityVersion }}
     runs-on: ubuntu-latest
@@ -35,6 +49,13 @@ jobs:
 
     steps:
       - uses: actions/checkout@v1
+      - uses: actions/cache@v1.1.0
+        with:
+          path: ${{ matrix.projectPath }}/Library
+          key: Library-${{ matrix.projectPath }}-${{ matrix.targetPlatform }}
+          restore-keys: |
+            Library-${{ matrix.projectPath }}-
+            Library-
       - uses: ./
         with:
           projectPath: ${{ matrix.projectPath }}

.github/workflows/test.yml

@@ -1,19 +0,0 @@
-name: Test Action
-
-on:
-  pull_request: {}
-  push: { branches: [master] }
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 12.x
-      - run: yarn
-      - run: yarn lint
-      - run: yarn test
-      - run: yarn build || { echo "build command should always succeed" ; exit 61; }
-      - run: yarn build --quiet && git diff --quiet builder || { echo "builder should be auto generated" ; exit 62; }

README.md

@@ -34,7 +34,7 @@ collection repository for workflow documentation and reference implementation.
 Create or edit the file called `.github/workflows/main.yml` and add a job to it.
 
 ```yaml
-- uses: webbertakken/unity-builder@v0.5
+- uses: webbertakken/unity-builder@v0.9
   env:
     UNITY_LICENSE: ${{ secrets.UNITY_LICENSE }}
   with:
@@ -82,7 +82,7 @@ jobs:
           - Switch # Build a Nintendo Switch player.
     steps:
       - uses: actions/checkout@v1
-      - uses: webbertakken/unity-builder@v0.5
+      - uses: webbertakken/unity-builder@v0.9
         with:
           projectPath: ${{ matrix.projectPath }}
           unityVersion: ${{ matrix.unityVersion }}
@@ -161,6 +161,25 @@ _**example:**_
 _**required:** `false`_
 _**default:** Built-in script that will run a build out of the box._
 
+#### customParameters
+
+Custom parameters to configure the build.
+
+Parameters must start with a hyphen (`-`) and may be followed by a value (without hyphen).
+
+Parameters without a value will be considered booleans (with a value of true).
+
+_**example:**_
+
+```yaml
+- uses: webbertakken/unity-builder@master
+  with:
+    customParameters: -profile SomeProfile -someBoolean -someValue exampleValue
+```
+
+_**required:** `false`_
+_**default:** ""_
+
 ## More actions
 
 Visit

builder/steps/activate.sh

@@ -6,11 +6,11 @@ if [[ -n "$UNITY_LICENSE" ]]; then
   #
   # This will activate Unity, using a license file
   #
-  # Note that this is the ONLY WAY for PERSONAL LICENSES in 2019.
+  # Note that this is the ONLY WAY for PERSONAL LICENSES in 2020.
   #   * See for more details: https://gitlab.com/gableroux/unity3d-gitlab-ci-example/issues/5#note_72815478
   #
   # The license file can be acquired using `webbertakken/request-manual-activation-file` action.
-  LICENSE_MODE="personal"
+  echo "Requesting activation (personal license)"
 
   # Set the license file path
   FILE_PATH=UnityLicenseFile.ulf
@@ -18,12 +18,7 @@ if [[ -n "$UNITY_LICENSE" ]]; then
   # Copy license file from Github variables
   echo "$UNITY_LICENSE" | tr -d '\r' > $FILE_PATH
 
-  #
   # Activate license
-  #
-  # This is expected to always exit with code 1 (both success and failure).
-  #
-  echo "Requesting activation"
   ACTIVATION_OUTPUT=$(xvfb-run --auto-servernum --server-args='-screen 0 640x480x24' \
     /opt/Unity/Editor/Unity \
       -batchmode \
@@ -31,17 +26,23 @@ if [[ -n "$UNITY_LICENSE" ]]; then
       -logFile /dev/stdout \
       -quit \
       -manualLicenseFile $FILE_PATH)
-  # Convert to exit code 0 by echoing the current exit code.
-  echo $?
-  # Exit code is now 0
 
-  # TODO - remove debugging
-  echo $ACTIVATION_OUTPUT
-  echo $ACTIVATION_OUTPUT | grep 'config is NOT valid, switching to default'
-  echo $ACTIVATION_OUTPUT | grep 'config is NOT valid, switching to default' | wc -l
+  # Store the exit code from the verify command
+  UNITY_EXIT_CODE=$?
 
-  # TODO - Derive exit code by grepping success statement
-  UNITY_EXIT_CODE=$(echo $ACTIVATION_OUTPUT | grep 'config is NOT valid, switching to default' | wc -l)
+  # The exit code for personal activation is always 1;
+  # Determine whether activation was successful.
+  #
+  # Successful output should include the following:
+  #
+  #   "LICENSE SYSTEM [2020120 18:51:20] Next license update check is after 2019-11-25T18:23:38"
+  #
+  ACTIVATION_SUCCESSFUL=$(echo $ACTIVATION_OUTPUT | grep 'Next license update check is after' | wc -l)
+
+  # Set exit code to 0 if activation was successful
+  if [[ $ACTIVATION_SUCCESSFUL -eq 1 ]]; then
+    UNITY_EXIT_CODE=0
+  fi;
 
   # Remove license file
   rm -f $FILE_PATH
@@ -54,8 +55,9 @@ elif [[ -n "$UNITY_SERIAL" && -n "$UNITY_EMAIL" && -n "$UNITY_PASSWORD" ]]; then
   #
   # Note: This is the preferred way for PROFESSIONAL LICENSES.
   #
-  LICENSE_MODE="professional"
+  echo "Requesting activation (professional license)"
 
+  # Activate license
   xvfb-run --auto-servernum --server-args='-screen 0 640x480x24' \
     /opt/Unity/Editor/Unity \
       -batchmode \
@@ -71,16 +73,18 @@ elif [[ -n "$UNITY_SERIAL" && -n "$UNITY_EMAIL" && -n "$UNITY_PASSWORD" ]]; then
 
 else
   #
-  # LICENSE ACTIVATION FAILED
+  # NO LICENSE ACTIVATION STRATEGY MATCHED
   #
-  # This will exit since both personal and professional activation modes failed
+  # This will exit since no activation strategies could be matched.
   #
-  echo "No personal or professional licenses provided!"
-  echo "Please ensure you have setup one of these licensing methods:"
-  echo "  - Personal: Set the UNITY_LICENSE environment variable."
-  echo "  - Professional: Set the UNITY_EMAIL, UNITY_PASSWORD and UNITY_SERIAL environment variables."
-  echo "See https://github.com/webbertakken/unity-builder#usage for details."
+  echo "License activation strategy could not be determined."
+  echo ""
+  echo "Visit https://github.com/webbertakken/unity-builder#usage for more"
+  echo "details on how to set up one of the possible activation strategies."
+
+  # Immediately exit as no UNITY_EXIT_CODE can be derrived.
   exit 1;
+
 fi
 
 #
@@ -88,10 +92,10 @@ fi
 #
 if [ $UNITY_EXIT_CODE -eq 0 ]; then
   # Activation was a success
-  echo "Activation ($LICENSE_MODE) complete."
+  echo "Activation complete."
 else
   # Activation failed so exit with the code from the license verification step
-  echo "Unclassified error occured while trying to activate ($LICENSE_MODE) license."
+  echo "Unclassified error occured while trying to activate license."
   echo "Exit code was: $UNITY_EXIT_CODE"
   exit $UNITY_EXIT_CODE
 fi

builder/steps/build.sh

@@ -58,13 +58,14 @@ else
   # User has provided their own build method.
   # Assume they also bring their own script.
   #
-  echo "User set build method to $BUILD_METHOD."
+  echo "Using build method \"$BUILD_METHOD\"."
   #
 fi
 
-# Set build method to execute as flag + argument
-EXECUTE_BUILD_METHOD="-executeMethod $BUILD_METHOD"
-
+#
+# Display custom parameters
+#
+echo "Using custom parameters \"$CUSTOM_PARAMETERS\"."
 
 # The build specification below may require Unity 2019.2.11f1 or later (not tested below).
 # Reference: https://docs.unity3d.com/2019.3/Documentation/Manual/CommandLineArguments.html
@@ -107,7 +108,8 @@ xvfb-run --auto-servernum --server-args='-screen 0 640x480x24' \
     -buildTarget "$BUILD_TARGET" \
     -customBuildTarget "$BUILD_TARGET" \
     -customBuildPath "$CUSTOM_BUILD_PATH" \
-    $EXECUTE_BUILD_METHOD
+    -executeMethod "$BUILD_METHOD" \
+    "$CUSTOM_PARAMETERS"
 
 # Catch exit code
 BUILD_EXIT_CODE=$?

src/index.js

@@ -1,8 +1,4 @@
-import Action from './model/action';
-import Docker from './model/docker';
-import ImageTag from './model/image-tag';
-import Input from './model/input';
-import BuildParameters from './model/build-parameters';
+import { Action, Docker, Input, ImageTag, BuildParameters } from './model';
 
 const core = require('@actions/core');
 

src/model/build-parameters.js

@@ -9,6 +9,7 @@ class BuildParameters {
       buildName,
       buildsPath,
       buildMethod,
+      customParameters,
     } = parameters;
 
     return {
@@ -19,6 +20,7 @@ class BuildParameters {
       buildPath: `${buildsPath}/${targetPlatform}`,
       buildFile: this.parseBuildFile(buildName, targetPlatform),
       buildMethod,
+      customParameters,
     };
   }
 

src/model/docker.js

@@ -27,6 +27,7 @@ class Docker {
       buildPath,
       buildFile,
       buildMethod,
+      customParameters,
     } = parameters;
 
     const command = `docker run \
@@ -43,6 +44,7 @@ class Docker {
         --env BUILD_PATH=${buildPath} \
         --env BUILD_FILE=${buildFile} \
         --env BUILD_METHOD=${buildMethod} \
+        --env CUSTOM_PARAMETERS=${customParameters} \
         --env HOME=/github/home \
         --env GITHUB_REF \
         --env GITHUB_SHA \

src/model/index.js

@@ -0,0 +1,8 @@
+import Action from './action';
+import BuildParameters from './build-parameters';
+import Docker from './docker';
+import Input from './input';
+import ImageTag from './image-tag';
+import Platform from './platform';
+
+export { Action, BuildParameters, Docker, Input, ImageTag, Platform };

src/model/input.js

@@ -7,10 +7,11 @@ class Input {
     // Input variables specified in workflows using "with" prop.
     const unityVersion = core.getInput('unityVersion');
     const targetPlatform = core.getInput('targetPlatform') || Platform.default;
-    const projectPath = core.getInput('projectPath');
+    const projectPath = core.getInput('projectPath') || '.';
     const buildName = core.getInput('buildName') || targetPlatform;
     const buildsPath = core.getInput('buildsPath') || 'build';
     const buildMethod = core.getInput('buildMethod'); // processed in docker file
+    const customParameters = core.getInput('customParameters') || '';
 
     return {
       unityVersion,
@@ -19,6 +20,7 @@ class Input {
       buildName,
       buildsPath,
       buildMethod,
+      customParameters,
     };
   }
 }