Change the implementation of AzureDevops task.

Change the implementation of AzureDevops task. Instead of embedding the executables, installing GitVersion.Tool with a versionSpec

Author: arturcic

build/pack.cake

@@ -177,20 +177,6 @@ Task("Copy-Files")
     // Commandline
     PublishILRepackedGitVersionExe(false, ilMergeDir, cmdlineDir, parameters);
 
-    // Vsix
-    var vsixPath = new DirectoryPath("./src/GitVersionVsixTask/GitVersionTask");
-
-    var vsixPathFull = vsixPath.Combine("full");
-    EnsureDirectoryExists(vsixPathFull);
-    CopyFileToDirectory(portableDir + "/" + "LibGit2Sharp.dll.config", vsixPathFull);
-    CopyFileToDirectory(portableDir + "/" + "GitVersion.exe", vsixPathFull);
-    CopyDirectory(portableDir.Combine("lib"), vsixPathFull.Combine("lib"));
-
-    // Vsix dotnet core
-    var vsixPathCore = vsixPath.Combine("core");
-    EnsureDirectoryExists(vsixPathCore);
-    CopyDirectory(coreFxDir, vsixPathCore);
-
     // Ruby Gem
     var gemPath = new DirectoryPath("./src/GitVersionRubyGem/bin");
     EnsureDirectoryExists(gemPath);
@@ -200,7 +186,7 @@ Task("Copy-Files")
 });
 
 Task("Pack-Vsix")
-    .IsDependentOn("Copy-Files")
+    .IsDependentOn("Test")
     .Does<BuildParameters>((parameters) =>
 {
     var workDir = "./src/GitVersionVsixTask";

src/GitVersionVsixTask/GitVersion.ts

@@ -1,26 +1,31 @@
 import * as path from 'path';
-import * as os from 'os';
 
 import * as tl from 'azure-pipelines-task-lib/task';
 import * as tr from 'azure-pipelines-task-lib/toolrunner';
 
+import { ToolInstaller } from './ToolInstaller';
+
 export class GitVersionTask {
     execOptions: tr.IExecOptions;
 
-    preferBundledVersion: boolean;
+    versionSpec: string;
+    includePrerelease: boolean;
+    targetPath: string;
+
     useConfigFile: boolean;
     configFilePath: string;
-    updateAssemblyInfo: boolean;
 
+    updateAssemblyInfo: boolean;
     updateAssemblyInfoFilename: string;
+
     additionalArguments: string;
-    targetPath: string;
+
     sourcesDirectory: string;
-    gitVersionPath: string;
-    runtime: string;
 
     constructor() {
 
+        this.versionSpec                = tl.getInput('versionSpec', true);
+        this.includePrerelease          = tl.getBoolInput('includePrerelease');
         this.targetPath                 = tl.getInput('targetPath');
 
         this.useConfigFile              = tl.getBoolInput('useConfigFile');
@@ -29,10 +34,6 @@ export class GitVersionTask {
         this.updateAssemblyInfo         = tl.getBoolInput('updateAssemblyInfo');
         this.updateAssemblyInfoFilename = tl.getInput('updateAssemblyInfoFilename');
 
-        this.preferBundledVersion       = tl.getBoolInput('preferBundledVersion');
-        this.runtime                    = tl.getInput('runtime') || 'core';
-        this.gitVersionPath             = tl.getInput('gitVersionPath');
-
         this.additionalArguments        = tl.getInput('additionalArguments');
 
         this.sourcesDirectory           = tl.getVariable('Build.SourcesDirectory').replace(/\\/g, '/');
@@ -51,8 +52,10 @@ export class GitVersionTask {
 
     public async execute() {
         try {
+            let toolPath = await this.installTool(this.versionSpec, this.includePrerelease);
+
             let workingDirectory = this.getWorkingDirectory(this.targetPath);
-            let exe = this.getExecutable();
+            let exe = tl.tool('dotnet-gitversion');
             exe.arg([
                 workingDirectory,
                 "/output",
@@ -95,48 +98,14 @@ export class GitVersionTask {
         }
     }
 
-    public getExecutable(){
-        let exe: tr.ToolRunner;
-
-        switch (this.runtime) {
-            case "full":
-                const isWin32 = os.platform() == "win32";
-                let exePath = this.getExecutablePath("GitVersion.exe") || tl.which("GitVersion.exe", true);
-                if (isWin32) {
-                    exe = tl.tool(exePath);
-                } else {
-                    exe = tl.tool("mono");
-                    exe.arg(exePath);
-                }
-                break;
-            case "core":
-                let assemblyPath = this.getExecutablePath("GitVersion.dll");
-                let dotnetPath = tl.which("dotnet", true);
-                exe = tl.tool(dotnetPath);
-                exe.arg(assemblyPath);
-                break;
+    async installTool(version: string, includePrerelease: boolean) : Promise<string> {
+        let installTool = tl.getVariable("INSTALL_TOOL");
+        if (installTool === null || installTool === undefined || installTool.toUpperCase() == "TRUE") {
+            return await new ToolInstaller().downloadAndInstall("GitVersion.Tool", version, false, includePrerelease);
         }
-
-        return exe;
-    }
-
-    public getExecutablePath(exeName:string) {
-        let exePath;
-        if (this.preferBundledVersion) {
-            let currentDirectory = __dirname;
-            exePath = path.join(currentDirectory, this.runtime, exeName);
-        } else {
-            if (tl.filePathSupplied('gitVersionPath') && tl.exist(this.gitVersionPath) && tl.stats(this.gitVersionPath).isFile()) {
-                exePath = this.gitVersionPath;
-            } else{
-                throw new Error('GitVersion executable not found at ' + this.gitVersionPath);
-            }
-        }
-
-        return exePath.replace(/\\/g, '/');
     }
 
-    public getWorkingDirectory(targetPath: string) {
+    getWorkingDirectory(targetPath: string) {
         let workDir;
 
         if (!targetPath){

src/GitVersionVsixTask/GitVersionTask/task.json

@@ -8,48 +8,47 @@
     "category": "Build",
     "demands": [],
     "version": {
-        "Major": "4",
+        "Major": "5",
         "Minor": "0",
-        "Patch": "0"
+        "Patch": "2"
     },
     "minimumAgentVersion": "2.115.0",
     "groups": [{
-        "name": "gitversionDetails",
-        "displayName": "GitVersion details",
-        "isExpanded": true,
-        "visibleRule": "preferBundledVersion = false"
-    }, {
-        "name": "additional",
-        "displayName": "Additional Options",
-        "isExpanded": false
-    }],
+            "name": "gitversionDetails",
+            "displayName": "GitVersion details",
+            "isExpanded": true
+        },
+        {
+            "name": "additional",
+            "displayName": "Additional Options",
+            "isExpanded": false
+        }
+    ],
     "instanceNameFormat": "GitVersion",
     "inputs": [{
-            "name": "runtime",
-            "type": "radio",
-            "label": "Runtime",
-            "defaultValue": "core",
+            "name": "versionSpec",
+            "type": "string",
+            "label": "The version spec",
+            "defaultValue": "",
             "required": true,
-            "options": {
-                "core": "dotnet core",
-                "full": "dotnet fullframework (or mono)"
-            },
-            "helpMarkDown": "Specify the runtime used for running the tool"
-        }, {
-            "name": "preferBundledVersion",
+            "helpMarkDown": "Required version in the form of 5.x or exact version like 5.0.0"
+        },
+        {
+            "name": "includePrerelease",
             "type": "boolean",
-            "label": "Prefer bundled GitVersion",
-            "defaultValue": "true",
+            "label": "Include pre-release versions",
+            "defaultValue": "false",
             "required": false,
-            "helpMarkDown": "If checked it will prefer the bundled version over a version found in path"
-        }, {
-            "name": "gitVersionPath",
+            "helpMarkDown": "Include pre-release versions when matching a version"
+        },
+        {
+            "name": "targetPath",
             "type": "string",
-            "label": "Path to GitVersion",
+            "label": "Working directory path",
             "defaultValue": "",
             "required": false,
-            "helpMarkDown": "Optionally supply the path to GitVersion",
-            "visibleRule": "preferBundledVersion = true"
+            "helpMarkDown": "Optionally supply the path to the working directory",
+            "groupName": "gitversionDetails"
         },
         {
             "name": "useConfigFile",
@@ -58,38 +57,34 @@
             "defaultValue": "false",
             "required": false,
             "helpMarkDown": "Whether to use a custom configuration file"
-        }, {
+        },
+        {
             "name": "configFilePath",
             "type": "filePath",
             "label": "Configuration file",
             "defaultValue": "",
             "required": false,
             "helpMarkDown": "Optional path to config file (defaults to GitVersion.yml)",
             "visibleRule": "useConfigFile = true"
-        }, {
+        },
+        {
             "name": "updateAssemblyInfo",
             "type": "boolean",
             "label": "Update AssemblyInfo files",
             "defaultValue": "false",
             "required": false,
             "helpMarkDown": "Whether to update versions in the AssemblyInfo files"
-        }, {
+        },
+        {
             "name": "updateAssemblyInfoFilename",
             "type": "string",
             "label": "Update Assembly File",
             "defaultValue": "",
             "required": false,
             "helpMarkDown": "Update versions in specified file",
             "visibleRule": "updateAssemblyInfo = true"
-        }, {
-            "name": "targetPath",
-            "type": "string",
-            "label": "Working directory path",
-            "defaultValue": "",
-            "required": false,
-            "helpMarkDown": "Optionally supply the path to the working directory",
-            "groupName": "gitversionDetails"
-        }, {
+        },
+        {
             "name": "additionalArguments",
             "type": "string",
             "label": "Additional GitVersion arguments",