Merge pull request #1391 from arturcic/fix/1389

#1389 - fix setting the build version in azure devops

dist/tools/azure/agent.mjs

@@ -80,6 +80,11 @@ class BuildAgent extends BuildAgentBase {
   setFailed = (message, done) => this._setResult(TaskResult.Failed, message, done);
   setOutput = (name, value) => this._setVariable(name, value, true);
   setVariable = (name, value) => this._setVariable(name, value);
+  updateBuildNumber = (version) => this._updateBuildNumber(version);
+  _updateBuildNumber(version) {
+    this.debug(`build number: ${version}`);
+    issueCommand("build.updatebuildnumber", {}, version);
+  }
   _setResult(result, message, done) {
     this.debug(`task result: ${TaskResult[result]}`);
     if (result === TaskResult.Failed && message) {

dist/tools/github/agent.mjs

@@ -132,6 +132,7 @@ class BuildAgent extends BuildAgentBase {
     }
     issueCommand("set-env", { name }, convertedVal);
   };
+  updateBuildNumber = (version) => this.debug(`updateBuildNumber - ${version}`);
 }
 
 export { BuildAgent };

dist/tools/libs/gitversion.mjs

@@ -88,6 +88,10 @@ class GitVersionTool extends DotnetTool {
         this.buildAgent.error(`Unable to set output/variable for ${property}`);
       }
     }
+    if (output.FullSemVer.endsWith("+0")) {
+      output.FullSemVer = output.FullSemVer.slice(0, -2);
+    }
+    this.buildAgent.updateBuildNumber(output.FullSemVer);
   }
   async getRepoDir(settings) {
     return await super.getRepoPath(settings.targetPath);

dist/tools/local/agent.mjs

@@ -25,6 +25,7 @@ class BuildAgent extends BuildAgentBase {
     this.debug(`setVariable - ${name} - ${value}`);
     process.env[name] = value;
   }
+  updateBuildNumber = (version) => this.debug(`updateBuildNumber - ${version}`);
 }
 
 export { BuildAgent };

src/__tests__/agents/azure/build-agent.spec.ts

@@ -119,4 +119,14 @@ describe.skipIf(isAzurePipelines)('build-agent/azure', () => {
         expect(spy).toHaveBeenCalledTimes(1)
         expect(spy).toHaveBeenCalledWith(`##vso[task.setvariable variable=test;isOutput=true;issecret=false;]value${os.EOL}`)
     })
+
+    it('should update build number', () => {
+        const spyDebug = vi.spyOn(agent, 'debug')
+        const spyWrite = vi.spyOn(process.stdout, 'write')
+
+        agent.updateBuildNumber('test')
+        expect(spyDebug).toHaveBeenCalledTimes(1)
+        expect(spyDebug).toHaveBeenCalledWith('build number: test')
+        expect(spyWrite).toHaveBeenCalledWith(`##vso[build.updatebuildnumber]test${os.EOL}`)
+    })
 })

src/__tests__/agents/github/build-agent.spec.ts

@@ -147,4 +147,12 @@ describe.skipIf(isGitHubActions)('build-agent/github', () => {
         expect(spy).toHaveBeenCalledTimes(1)
         expect(spy).toHaveBeenCalledWith(`::set-env name=name::value${os.EOL}`)
     })
+
+    it('should update build number', () => {
+        const spy = vi.spyOn(process.stdout, 'write')
+
+        agent.updateBuildNumber('test')
+        expect(spy).toHaveBeenCalledTimes(1)
+        expect(spy).toHaveBeenCalledWith(`::debug::updateBuildNumber - test${os.EOL}`)
+    })
 })

src/__tests__/agents/local/build-agent.spec.ts

@@ -90,4 +90,12 @@ describe('build-agent/local', () => {
         expect(spy).toHaveBeenCalledTimes(1)
         expect(spy).toHaveBeenCalledWith('setOutput - test - value')
     })
+
+    it('should update build number', () => {
+        const spy = vi.spyOn(agent, 'debug')
+
+        agent.updateBuildNumber('test')
+        expect(spy).toHaveBeenCalledTimes(1)
+        expect(spy).toHaveBeenCalledWith('updateBuildNumber - test')
+    })
 })

src/__tests__/tools/gitversion/tool.spec.ts

@@ -58,6 +58,9 @@ describe('GitVersionTool', () => {
                 },
                 setVariable(name: string, value: string) {
                     variables.set(name, value)
+                },
+                updateBuildNumber(_version: string): void {
+                    return
                 }
             } as IBuildAgent
             tool = new TestGitVersionTool(buildAgent)

src/agents/azure/build-agent.ts

@@ -33,6 +33,13 @@ export class BuildAgent extends BuildAgentBase implements IBuildAgent {
 
     setVariable = (name: string, value: string): void => this._setVariable(name, value)
 
+    updateBuildNumber = (version: string): void => this._updateBuildNumber(version)
+
+    private _updateBuildNumber(version: string): void {
+        this.debug(`build number: ${version}`)
+        issueCommand('build.updatebuildnumber', {}, version)
+    }
+
     private _setResult(result: TaskResult, message: string, done?: boolean): void {
         this.debug(`task result: ${TaskResult[result]}`)
         // add an error issue

src/agents/common/build-agent.ts

@@ -61,6 +61,8 @@ export interface IBuildAgent {
 
     setVariable(name: string, value: string): void
 
+    updateBuildNumber: (version: string) => void
+
     which(tool: string, check?: boolean): Promise<string>
 }
 
@@ -86,6 +88,8 @@ export abstract class BuildAgentBase implements IBuildAgent {
 
     abstract setVariable(name: string, value: string): void
 
+    abstract updateBuildNumber: (version: string) => void
+
     get sourceDir(): string {
         return this.getVariableAsPath(this.sourceDirVariable)?.replace(/\\/g, '/')
     }

src/agents/github/build-agent.ts

@@ -60,4 +60,6 @@ export class BuildAgent extends BuildAgentBase implements IBuildAgent {
 
         issueCommand('set-env', { name }, convertedVal)
     }
+
+    updateBuildNumber = (version: string): void => this.debug(`updateBuildNumber - ${version}`)
 }

src/agents/local/build-agent.ts

@@ -35,4 +35,6 @@ export class BuildAgent extends BuildAgentBase implements IBuildAgent {
         this.debug(`setVariable - ${name} - ${value}`)
         process.env[name] = value
     }
+
+    updateBuildNumber = (version: string): void => this.debug(`updateBuildNumber - ${version}`)
 }

src/tools/gitversion/tool.ts

@@ -64,6 +64,11 @@ export class GitVersionTool extends DotnetTool {
                 this.buildAgent.error(`Unable to set output/variable for ${property}`)
             }
         }
+
+        if (output.FullSemVer.endsWith('+0')) {
+            output.FullSemVer = output.FullSemVer.slice(0, -2)
+        }
+        this.buildAgent.updateBuildNumber(output.FullSemVer)
     }
 
     protected async getRepoDir(settings: ExecuteSettings | CommandSettings): Promise<string> {