Fix getVersionDescription() to prioritize version tags over non-version tags (#673)

* Fix getVersionDescription() to prioritize version tags over non-version tags

This fix modifies the getVersionDescription() method to ensure it only considers valid version tags when describing the current version. It retrieves all tags merged into the current branch, filters them based on a version-compatible regex, and uses the most recent valid version tag for description. If no valid tags are found, it falls back to the default description behavior. This resolves the issue of incorrect tags being used when multiple tags are present.

* Update versioning.ts

Rewrote getting the description for the last valid tag using `rev-list` and `rev-parse`

* Fix formatting

* Revert "dist"

This reverts commit bd58cbedf7.

* Revert "dist"

This reverts commit bd58cbedf7.

dist/index.js

@@ -6108,6 +6108,7 @@ class Docker {
             --volume "C:/ProgramData/Microsoft/VisualStudio":"C:/ProgramData/Microsoft/VisualStudio" \
             --volume "${actionFolder}/default-build-script":"c:/UnityBuilderAction" \
             --volume "${actionFolder}/platforms/windows":"c:/steps" \
+            --volume "${actionFolder}/unity-config":"C:/ProgramData/Unity/config" \
             --volume "${actionFolder}/BlankProject":"c:/BlankProject" \
             --cpus=${dockerCpuLimit} \
             --memory=${dockerMemoryLimit} \
@@ -6521,7 +6522,7 @@ class ImageTag {
         this.imageRollingVersion = Number(containerRegistryImageVersion); // Will automatically roll to the latest non-breaking version.
     }
     static get versionPattern() {
-        return /^(20\d{2}\.\d\.\w{3,4}|3)$/;
+        return /^\d+\.\d+\.\d+[a-z]\d+$/;
     }
     static get targetPlatformSuffixes() {
         return {
@@ -7524,9 +7525,12 @@ const node_fs_1 = __importDefault(__nccwpck_require__(87561));
 class ValidateWindows {
     static validate(buildParameters) {
         ValidateWindows.validateWindowsPlatformRequirements(buildParameters.targetPlatform);
-        if (!(process.env.UNITY_EMAIL && process.env.UNITY_PASSWORD)) {
+        const { unityLicensingServer } = buildParameters;
-            throw new Error(`Unity email and password must be set for Windows based builds to
+        const hasLicensingCredentials = process.env.UNITY_EMAIL && process.env.UNITY_PASSWORD;
-                       authenticate the license. Make sure to set them inside UNITY_EMAIL
+        const hasValidLicensingStrategy = hasLicensingCredentials || unityLicensingServer;
+        if (!hasValidLicensingStrategy) {
+            throw new Error(`Unity email and password or alternatively a Unity licensing server url must be set for 
+                       Windows based builds to authenticate the license. Make sure to set them inside UNITY_EMAIL
                        and UNITY_PASSWORD in Github Secrets and pass them into the environment.`);
         }
     }
@@ -8006,7 +8010,17 @@ class Versioning {
      * identifies the current commit.
      */
     static async getVersionDescription() {
-        return this.git(['describe', '--long', '--tags', '--always', 'HEAD']);
+        const versionTags = (await this.git(['tag', '--list', '--merged', 'HEAD', '--sort=-creatordate']))
+            .split('\n')
+            .filter(tag => new RegExp(this.grepCompatibleInputVersionRegex).test(tag));
+        if (versionTags.length === 0) {
+            core.warning('No valid version tags found. Using fallback description.');
+            return this.git(['describe', '--long', '--tags', '--always', 'HEAD']);
+        }
+        const latestVersionTag = versionTags[0];
+        const commitsCount = (await this.git(['rev-list', `${latestVersionTag}..HEAD`, '--count'])).trim();
+        const commitHash = (await this.git(['rev-parse', '--short', 'HEAD'])).trim();
+        return `${latestVersionTag}-${commitsCount}-g${commitHash}`;
     }
     /**
      * Returns whether there are uncommitted changes that are not ignored.

dist/platforms/windows/activate.ps1

@@ -50,6 +50,30 @@ if ( ($null -ne ${env:UNITY_SERIAL}) -and ($null -ne ${env:UNITY_EMAIL}) -and ($
       Start-Sleep -Seconds 3
   }
 }
+elseif( ($null -ne ${env:UNITY_LICENSING_SERVER}))
+{
+    #
+    # Custom Unity License Server
+    #
+
+    Write-Output "Adding licensing server config"
+
+    $ACTIVATION_OUTPUT = Start-Process -FilePath "$Env:UNITY_PATH\Editor\Data\Resources\Licensing\Client\Unity.Licensing.Client.exe" `
+                                       -ArgumentList "--acquire-floating" `
+                                       -NoNewWindow `
+                                       -PassThru `
+                                       -Wait `
+                                       -RedirectStandardOutput "license.txt"
+
+    $PARSEDFILE = (Get-Content "license.txt" | Select-String -AllMatches -Pattern '\".*?\"' | ForEach-Object { $_.Matches.Value }) -replace '"'
+
+    $env:FLOATING_LICENSE = $PARSEDFILE[1]
+    $FLOATING_LICENSE_TIMEOUT = $PARSEDFILE[3]
+
+    Write-Output "Acquired floating license: ""$env:FLOATING_LICENSE"" with timeout $FLOATING_LICENSE_TIMEOUT"
+    # Store the exit code from the verify command
+    $ACTIVATION_EXIT_CODE = $ACTIVATION_OUTPUT.ExitCode
+}
 else
 {
     #

dist/platforms/windows/return_license.ps1

@@ -6,7 +6,16 @@ Write-Output "#      Return License     #"
 Write-Output "###########################"
 Write-Output ""
 
-if (($null -ne ${env:UNITY_SERIAL}) -and ($null -ne ${env:UNITY_EMAIL}) -and ($null -ne ${env:UNITY_PASSWORD}))
+if (($null -ne ${env:UNITY_LICENSING_SERVER}))
+{
+  Write-Output "Returning floating license: ""$env:FLOATING_LICENSE"""
+  Start-Process -FilePath "$Env:UNITY_PATH\Editor\Data\Resources\Licensing\Client\Unity.Licensing.Client.exe" `
+                -ArgumentList "--return-floating ""$env:FLOATING_LICENSE"" " `
+                -NoNewWindow `
+                -Wait
+}
+
+elseif (($null -ne ${env:UNITY_SERIAL}) -and ($null -ne ${env:UNITY_EMAIL}) -and ($null -ne ${env:UNITY_PASSWORD}))
 {
   #
   # SERIAL LICENSE MODE

dist/platforms/windows/set_gitcredential.ps1

@@ -5,12 +5,12 @@ else {
     Write-Host "GIT_PRIVATE_TOKEN is set configuring git credentials"
 
     git config --global credential.helper store
-    git config --global --replace-all "url.https://token:$env:GIT_PRIVATE_TOKEN@github.com/".insteadOf "ssh://git@github.com/"
+    git config --global --replace-all url."https://token:$env:GIT_PRIVATE_TOKEN@github.com/".insteadOf "ssh://git@github.com/"
-    git config --global --add "url.https://token:$env:GIT_PRIVATE_TOKEN@github.com/".insteadOf "git@github.com"
+    git config --global --add url."https://token:$env:GIT_PRIVATE_TOKEN@github.com/".insteadOf "git@github.com"
-    git config --global --add "url.https://token:$env:GIT_PRIVATE_TOKEN@github.com/".insteadOf "https://github.com/"
+    git config --global --add url."https://token:$env:GIT_PRIVATE_TOKEN@github.com/".insteadOf "https://github.com/"
 
-    git config --global "url.https://ssh:$env:GIT_PRIVATE_TOKEN@github.com/".insteadOf "ssh://git@github.com/"
+    git config --global url."https://ssh:$env:GIT_PRIVATE_TOKEN@github.com/".insteadOf "ssh://git@github.com/"
-    git config --global "url.https://git:$env:GIT_PRIVATE_TOKEN@github.com/".insteadOf "git@github.com:"
+    git config --global url."https://git:$env:GIT_PRIVATE_TOKEN@github.com/".insteadOf "git@github.com:"
 }
 
 Write-Host "---------- git config --list -------------"

src/model/docker.ts

@@ -113,6 +113,7 @@ class Docker {
             --volume "C:/ProgramData/Microsoft/VisualStudio":"C:/ProgramData/Microsoft/VisualStudio" \
             --volume "${actionFolder}/default-build-script":"c:/UnityBuilderAction" \
             --volume "${actionFolder}/platforms/windows":"c:/steps" \
+            --volume "${actionFolder}/unity-config":"C:/ProgramData/Unity/config" \
             --volume "${actionFolder}/BlankProject":"c:/BlankProject" \
             --cpus=${dockerCpuLimit} \
             --memory=${dockerMemoryLimit} \

src/model/image-tag.test.ts

@@ -2,7 +2,7 @@ import ImageTag from './image-tag';
 
 describe('ImageTag', () => {
   const testImageParameters = {
-    editorVersion: '2099.9.f9f9',
+    editorVersion: '2099.9.9f9',
     targetPlatform: 'Test',
     builderPlatform: '',
     containerRegistryRepository: 'unityci/editor',
@@ -27,7 +27,7 @@ describe('ImageTag', () => {
       expect(image.builderPlatform).toStrictEqual(testImageParameters.builderPlatform);
     });
 
-    test.each(['2000.0.0f0', '2011.1.11f1'])('accepts %p version format', (version) => {
+    test.each(['2000.0.0f0', '2011.1.11f1', '6000.0.0f1'])('accepts %p version format', (version) => {
       expect(
         () =>
           new ImageTag({
@@ -50,23 +50,23 @@ describe('ImageTag', () => {
   describe('toString', () => {
     it('returns the correct version', () => {
       const image = new ImageTag({
-        editorVersion: '2099.1.1111',
+        editorVersion: '2099.1.1111f1',
         targetPlatform: testImageParameters.targetPlatform,
         containerRegistryRepository: 'unityci/editor',
         containerRegistryImageVersion: '3',
       });
       switch (process.platform) {
         case 'win32':
-          expect(image.toString()).toStrictEqual(`${defaults.image}:windows-2099.1.1111-3`);
+          expect(image.toString()).toStrictEqual(`${defaults.image}:windows-2099.1.1111f1-3`);
           break;
         case 'linux':
-          expect(image.toString()).toStrictEqual(`${defaults.image}:ubuntu-2099.1.1111-3`);
+          expect(image.toString()).toStrictEqual(`${defaults.image}:ubuntu-2099.1.1111f1-3`);
           break;
       }
     });
     it('returns customImage if given', () => {
       const image = new ImageTag({
-        editorVersion: '2099.1.1111',
+        editorVersion: '2099.1.1111f1',
         targetPlatform: testImageParameters.targetPlatform,
         customImage: `${defaults.image}:2099.1.1111@347598437689743986`,
         containerRegistryRepository: 'unityci/editor',

src/model/image-tag.ts

@@ -42,7 +42,7 @@ class ImageTag {
   }
 
   static get versionPattern(): RegExp {
-    return /^(20\d{2}\.\d\.\w{3,4}|3)$/;
+    return /^\d+\.\d+\.\d+[a-z]\d+$/;
   }
 
   static get targetPlatformSuffixes() {

src/model/platform-validation/validate-windows.ts

@@ -4,9 +4,14 @@ import { BuildParameters } from '..';
 class ValidateWindows {
   public static validate(buildParameters: BuildParameters) {
     ValidateWindows.validateWindowsPlatformRequirements(buildParameters.targetPlatform);
-    if (!(process.env.UNITY_EMAIL && process.env.UNITY_PASSWORD)) {
+
-      throw new Error(`Unity email and password must be set for Windows based builds to
+    const { unityLicensingServer } = buildParameters;
-                       authenticate the license. Make sure to set them inside UNITY_EMAIL
+    const hasLicensingCredentials = process.env.UNITY_EMAIL && process.env.UNITY_PASSWORD;
+    const hasValidLicensingStrategy = hasLicensingCredentials || unityLicensingServer;
+
+    if (!hasValidLicensingStrategy) {
+      throw new Error(`Unity email and password or alternatively a Unity licensing server url must be set for 
+                       Windows based builds to authenticate the license. Make sure to set them inside UNITY_EMAIL
                        and UNITY_PASSWORD in Github Secrets and pass them into the environment.`);
     }
   }

src/model/versioning.ts

@@ -207,7 +207,21 @@ export default class Versioning {
    * identifies the current commit.
    */
   static async getVersionDescription() {
-    return this.git(['describe', '--long', '--tags', '--always', 'HEAD']);
+    const versionTags = (await this.git(['tag', '--list', '--merged', 'HEAD', '--sort=-creatordate']))
+      .split('\n')
+      .filter((tag) => new RegExp(this.grepCompatibleInputVersionRegex).test(tag));
+
+    if (versionTags.length === 0) {
+      core.warning('No valid version tags found. Using fallback description.');
+
+      return this.git(['describe', '--long', '--tags', '--always', 'HEAD']);
+    }
+
+    const latestVersionTag = versionTags[0];
+    const commitsCount = (await this.git(['rev-list', `${latestVersionTag}..HEAD`, '--count'])).trim();
+    const commitHash = (await this.git(['rev-parse', '--short', 'HEAD'])).trim();
+
+    return `${latestVersionTag}-${commitsCount}-g${commitHash}`;
   }
 
   /**