Add input to set version code

Use action input `androidVersionCode` when provided. Generate the androidVersionCode from the version otherwise.

.github/workflows/main.yml

@@ -74,6 +74,7 @@ jobs:
           projectPath: ${{ matrix.projectPath }}
           unityVersion: ${{ matrix.unityVersion }}
           targetPlatform: ${{ matrix.targetPlatform }}
+          androidVersionCode: ${{ github.run_number }}
           customParameters: -profile SomeProfile -someBoolean -someValue exampleValue
       - uses: actions/upload-artifact@v1
         with:

README.md

@@ -295,6 +295,12 @@ No version will be set by Builder. **(not recommended)**
 > Not recommended unless you generate a new version in a pre-commit hook. Manually
 > setting versions is error-prone.
 
+#### androidVersionCode
+
+Configure the android `versionCode`.
+
+When not specified, the version code is generated from the version using the `major * 1000000 + minor * 1000 + patch` scheme;
+
 #### allowDirtyBuild
 
 Allows the branch of the build to be dirty, and still generate the build.

action.yml

@@ -26,6 +26,14 @@ inputs:
     required: false
     default: ''
     description: 'Path to a Namespace.Class.StaticMethod to run to perform the build.'
+  versioning:
+    required: false
+    default: 'Semantic'
+    description: 'The versioning scheme to use when building the project'
+  androidVersionCode:
+    required: false
+    default: ''
+    description: 'The android versionCode'
 outputs: {}
 branding:
   icon: 'box'

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

@@ -28,6 +28,7 @@ namespace UnityBuilderAction
 
       // Set version for this build
       VersionApplicator.SetVersion(options["version"]);
+      VersionApplicator.SetAndroidVersionCode(options["androidVersionCode"]);
 
       // Perform build
       BuildReport buildReport = BuildPipeline.BuildPlayer(buildOptions);

action/default-build-script/Assets/Editor/Versioning/VersionApplicator.cs

@@ -1,5 +1,4 @@
 using System;
-using JetBrains.Annotations;
 using UnityEditor;
 
 namespace UnityBuilderAction.Versioning
@@ -15,6 +14,10 @@ namespace UnityBuilderAction.Versioning
       Apply(version);
     }
 
+    public static void SetAndroidVersionCode(string androidVersionCode) {
+      PlayerSettings.Android.bundleVersionCode = Int32.Parse(androidVersionCode);
+    }
+
     static void Apply(string version)
     {
       PlayerSettings.bundleVersion = version;

action/steps/build.sh

@@ -109,8 +109,8 @@ xvfb-run --auto-servernum --server-args='-screen 0 640x480x24' \
     -customBuildTarget "$BUILD_TARGET" \
     -customBuildPath "$CUSTOM_BUILD_PATH" \
     -executeMethod "$BUILD_METHOD" \
-    -versioning "$VERSIONING" \
     -version "$VERSION" \
+    -androidVersionCode "$ANDROID_VERSION_CODE" \
     $CUSTOM_PARAMETERS
 
 # Catch exit code

package.json

@@ -10,12 +10,14 @@
     "prebuild": "yarn",
     "build": "ncc build src --out action --minify",
     "lint": "prettier --check \"src/**/*.js\" && eslint src",
+    "format": "prettier --write \"src/**/*.js\"",
     "test": "jest"
   },
   "dependencies": {
     "@actions/core": "^1.2.4",
     "@actions/exec": "1.0.4",
-    "@actions/github": "^2.1.1"
+    "@actions/github": "^2.1.1",
+    "semver": "^7.3.2"
   },
   "devDependencies": {
     "@babel/cli": "7.8.4",

src/model/android-versioning.js

@@ -0,0 +1,33 @@
+import * as core from '@actions/core';
+import * as semver from 'semver';
+
+export default class AndroidVersioning {
+  static determineVersionCode(version, inputVersionCode) {
+    if (!inputVersionCode) {
+      return AndroidVersioning.versionToVersionCode(version);
+    }
+    return inputVersionCode;
+  }
+
+  static versionToVersionCode(version) {
+    const parsedVersion = semver.parse(version);
+
+    if (!parsedVersion) {
+      core.warning(`Could not parse "${version}" to semver, defaulting android version code to 1`);
+      return 1;
+    }
+
+    // The greatest value Google Plays allows is 2100000000.
+    // Allow for 3 patch digits, 3 minor digits and 3 major digits.
+    const versionCode =
+      parsedVersion.major * 1000000 + parsedVersion.minor * 1000 + parsedVersion.patch;
+
+    if (versionCode >= 1000000000) {
+      throw new Error(
+        `Generated versionCode ${versionCode} is dangerously close to the maximum allowed number 2100000000. Consider a different versioning scheme to be able to continue updating your application.`,
+      );
+    }
+    core.info(`Using android versionCode ${versionCode}`);
+    return versionCode;
+  }
+}

src/model/android-versioning.test.js

@@ -0,0 +1,27 @@
+import AndroidVersioning from './android-versioning';
+
+describe('Android Versioning', () => {
+  describe('versionToVersionCode', () => {
+    it('defaults to 1 when version is not a valid semver', () => {
+      expect(AndroidVersioning.versionToVersionCode('abcd')).toBe(1);
+    });
+
+    it('returns a number', () => {
+      expect(AndroidVersioning.versionToVersionCode('123.456.789')).toBe(123456789);
+    });
+
+    it('throw when generated version code is too large', () => {
+      expect(() => AndroidVersioning.versionToVersionCode('1234.0.0')).toThrow();
+    });
+  });
+
+  describe('determineVersionCode', () => {
+    it('defaults to parsed version', () => {
+      expect(AndroidVersioning.determineVersionCode('1.2.3', '')).toBe(1002003);
+    });
+
+    it('use specified code', () => {
+      expect(AndroidVersioning.determineVersionCode('1.2.3', 2)).toBe(2);
+    });
+  });
+});

src/model/build-parameters.js

@@ -1,3 +1,4 @@
+import AndroidVersioning from './android-versioning';
 import Input from './input';
 import Platform from './platform';
 import Versioning from './versioning';
@@ -10,6 +11,11 @@ class BuildParameters {
       Input.specifiedVersion,
     );
 
+    const androidVersionCode = AndroidVersioning.determineVersionCode(
+      buildVersion,
+      Input.androidVersionCode,
+    );
+
     return {
       version: Input.unityVersion,
       platform: Input.targetPlatform,
@@ -19,6 +25,7 @@ class BuildParameters {
       buildFile,
       buildMethod: Input.buildMethod,
       buildVersion,
+      androidVersionCode,
       customParameters: Input.customParameters,
     };
   }

src/model/build-parameters.test.js

@@ -30,6 +30,22 @@ describe('BuildParameters', () => {
       );
     });
 
+    it('returns the android version code with provided input', async () => {
+      const mockValue = '42';
+      jest.spyOn(Input, 'androidVersionCode', 'get').mockReturnValue(mockValue);
+      await expect(BuildParameters.create()).resolves.toEqual(
+        expect.objectContaining({ androidVersionCode: mockValue }),
+      );
+    });
+
+    it('returns the android version code from version by default', async () => {
+      const mockValue = '';
+      jest.spyOn(Input, 'androidVersionCode', 'get').mockReturnValue(mockValue);
+      await expect(BuildParameters.create()).resolves.toEqual(
+        expect.objectContaining({ androidVersionCode: 1003037 }),
+      );
+    });
+
     it('returns the platform', async () => {
       const mockValue = 'somePlatform';
       jest.spyOn(Input, 'targetPlatform', 'get').mockReturnValue(mockValue);

src/model/docker.js

@@ -29,6 +29,7 @@ class Docker {
       buildMethod,
       buildVersion,
       customParameters,
+      androidVersionCode,
     } = parameters;
 
     const command = `docker run \
@@ -47,6 +48,7 @@ class Docker {
         --env BUILD_FILE="${buildFile}" \
         --env BUILD_METHOD="${buildMethod}" \
         --env VERSION="${buildVersion}" \
+        --env ANDROID_VERSION_CODE="${androidVersionCode}" \
         --env CUSTOM_PARAMETERS="${customParameters}" \
         --env HOME=/github/home \
         --env GITHUB_REF \

src/model/docker.test.js

@@ -25,7 +25,7 @@ describe('Docker', () => {
     const parameters = {
       workspace: Action.rootFolder,
       projectPath: `${Action.rootFolder}/test-project`,
-      buildName: 'someBulidName',
+      buildName: 'someBuildName',
       buildsPath: 'build',
       method: '',
     };

src/model/input.js

@@ -41,6 +41,10 @@ class Input {
     return core.getInput('version') || '';
   }
 
+  static get androidVersionCode() {
+    return core.getInput('androidVersionCode');
+  }
+
   static get allowDirtyBuild() {
     const input = core.getInput('allowDirtyBuild') || 'false';
 

src/model/input.test.js

@@ -118,6 +118,19 @@ describe('Input', () => {
     });
   });
 
+  describe('androidVersionCode', () => {
+    it('defaults to null', () => {
+      expect(Input.androidVersionCode).toBeFalsy();
+    });
+
+    it('takes input from the users workflow', () => {
+      const mockValue = '42';
+      const spy = jest.spyOn(core, 'getInput').mockReturnValue(mockValue);
+      expect(Input.androidVersionCode).toStrictEqual(mockValue);
+      expect(spy).toHaveBeenCalledTimes(1);
+    });
+  });
+
   describe('allowDirtyBuild', () => {
     it('returns the default value', () => {
       expect(Input.allowDirtyBuild).toStrictEqual('false');

yarn.lock

@@ -5045,7 +5045,7 @@ semver@^6.0.0, semver@^6.1.2, semver@^6.3.0:
   resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d"
   integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==
 
-semver@^7.1.3:
+semver@^7.1.3, semver@^7.3.2:
   version "7.3.2"
   resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.2.tgz#604962b052b81ed0786aae84389ffba70ffd3938"
   integrity sha512-OrOb32TeeambH6UrhtShmF7CRDqhL6/5XpPNp2DuRH6+9QLw/orhp72j87v8Qa1ScDkvrrBNpZcDejAirJmfXQ==