Sync input with documentation (#155)

action.yml

@@ -13,6 +13,9 @@ inputs:
   projectPath:
     required: false
     description: 'Path to the Unity project to be tested.'
+  customParameters:
+    required: false
+    description: 'Extra parameters to configure the Unity editor run.'
   testMode:
     required: false
     default: 'all'
@@ -24,19 +27,15 @@ inputs:
   useHostNetwork:
     required: false
     default: false
-    description: 'Initialises Docker using the hosts network.'
-  customParameters:
-    required: false
-    description: 'Extra parameters to configure the Unity editor run.'
+    description: 'Initialises Docker using the host network.'
   sshAgent:
     required: false
     default: ''
-    description: 'SSH Agent path to forward to the container'
+    description: 'SSH Agent path to forward to the container.'
   gitPrivateToken:
     required: false
     default: ''
-    description: >
-      Github private token to pull from github
+    description: 'GitHub Private Access Token (PAT) to pull from GitHub.'
   githubToken:
     required: false
     default: ''

src/index.js

@@ -9,11 +9,12 @@ async function action() {
     unityVersion,
     customImage,
     projectPath,
+    customParameters,
     testMode,
     artifactsPath,
     useHostNetwork,
-    customParameters,
     sshAgent,
+    gitPrivateToken,
     githubToken,
     checkName,
   } = Input.getFromUser();
@@ -25,14 +26,15 @@ async function action() {
 
     // Run docker image
     await Docker.run(actionImage, {
-      workspace,
       unityVersion,
+      workspace,
       projectPath,
+      customParameters,
       testMode,
       artifactsPath,
       useHostNetwork,
-      customParameters,
       sshAgent,
+      gitPrivateToken,
       githubToken,
     });
   } finally {

src/model/docker.js

@@ -22,13 +22,13 @@ class Docker {
       unityVersion,
       workspace,
       projectPath,
+      customParameters,
       testMode,
       artifactsPath,
       useHostNetwork,
-      customParameters,
       sshAgent,
-      githubToken,
       gitPrivateToken,
+      githubToken,
     } = parameters;
 
     const command = `docker run \
@@ -41,9 +41,9 @@ class Docker {
         --env UNITY_SERIAL \
         --env UNITY_VERSION="${unityVersion}" \
         --env PROJECT_PATH="${projectPath}" \
+        --env CUSTOM_PARAMETERS="${customParameters}" \
         --env TEST_MODE="${testMode}" \
         --env ARTIFACTS_PATH="${artifactsPath}" \
-        --env CUSTOM_PARAMETERS="${customParameters}" \
         --env GITHUB_REF \
         --env GITHUB_SHA \
         --env GITHUB_REPOSITORY \

src/model/input.js

@@ -17,29 +17,29 @@ class Input {
     // Input variables specified in workflow using "with" prop.
     const rawUnityVersion = getInput('unityVersion') || 'auto';
     const customImage = getInput('customImage') || '';
-    const testMode = (getInput('testMode') || 'all').toLowerCase();
     const rawProjectPath = getInput('projectPath') || '.';
+    const customParameters = getInput('customParameters') || '';
+    const testMode = (getInput('testMode') || 'all').toLowerCase();
     const rawArtifactsPath = getInput('artifactsPath') || 'artifacts';
     const rawUseHostNetwork = getInput('useHostNetwork') || 'false';
-    const customParameters = getInput('customParameters') || '';
     const sshAgent = getInput('sshAgent') || '';
+    const gitPrivateToken = getInput('gitPrivateToken') || '';
     const githubToken = getInput('githubToken') || '';
     const checkName = getInput('checkName') || 'Test Results';
-    const gitPrivateToken = getInput('gitPrivateToken') || '';
 
     // Validate input
     if (!includes(this.testModes, testMode)) {
       throw new Error(`Invalid testMode ${testMode}`);
     }
 
-    if (!this.isValidFolderName(rawArtifactsPath)) {
-      throw new Error(`Invalid artifactsPath "${rawArtifactsPath}"`);
-    }
-
     if (!this.isValidFolderName(rawProjectPath)) {
       throw new Error(`Invalid projectPath "${rawProjectPath}"`);
     }
 
+    if (!this.isValidFolderName(rawArtifactsPath)) {
+      throw new Error(`Invalid artifactsPath "${rawArtifactsPath}"`);
+    }
+
     if (rawUseHostNetwork !== 'true' && rawUseHostNetwork !== 'false') {
       throw new Error(`Invalid useHostNetwork "${rawUseHostNetwork}"`);
     }
@@ -56,14 +56,14 @@ class Input {
       unityVersion,
       customImage,
       projectPath,
+      customParameters,
       testMode,
       artifactsPath,
       useHostNetwork,
-      customParameters,
       sshAgent,
+      gitPrivateToken,
       githubToken,
       checkName,
-      gitPrivateToken,
     };
   }
 }