Adding UseBuildAgentBranch flag

Adding AzurePipelinesSetParamSkipIsOutput

Author: Michal Ciechan

src/GitVersionCore/BuildAgents/AzurePipelines.cs

@@ -1,16 +1,21 @@
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Text.RegularExpressions;
 using GitVersion.Extensions;
 using GitVersion.Logging;
 using GitVersion.OutputVariables;
+using Microsoft.Extensions.Options;
 
 namespace GitVersion.BuildAgents
 {
     public class AzurePipelines : BuildAgentBase
     {
-        public AzurePipelines(IEnvironment environment, ILog log) : base(environment, log)
+        private readonly Func<GitVersionOptions> options;
+
+        public AzurePipelines(IEnvironment environment, ILog log, Func<GitVersionOptions> options) : base(environment, log)
         {
+            this.options = options;
         }
 
         public const string EnvironmentVariableName = "TF_BUILD";
@@ -19,11 +24,20 @@ public AzurePipelines(IEnvironment environment, ILog log) : base(environment, lo
 
         public override string[] GenerateSetParameterMessage(string name, string value)
         {
-            return new[]
-            {
-                $"##vso[task.setvariable variable=GitVersion.{name}]{value}",
-                $"##vso[task.setvariable variable=GitVersion.{name};isOutput=true]{value}"
-            };
+            var standardSet = $"##vso[task.setvariable variable=GitVersion.{name}]{value}";
+            var isOutputSet = $"##vso[task.setvariable variable=GitVersion.{name};isOutput=true]{value}";
+
+            return options().Settings.AzurePipelinesSetParamSkipIsOutput
+                ? new[]
+                {
+                    standardSet
+                }
+                : new[]
+                {
+                    standardSet,
+                    isOutputSet
+
+                };
         }
 
         public override string GetCurrentBranch(bool usingDynamicRepos)

src/GitVersionCore/Core/GitVersionContextFactory.cs

@@ -2,6 +2,7 @@
 using GitVersion.Common;
 using GitVersion.Configuration;
 using GitVersion.Extensions;
+using GitVersion.Logging;
 using LibGit2Sharp;
 using Microsoft.Extensions.Options;
 
@@ -13,21 +14,45 @@ public class GitVersionContextFactory : IGitVersionContextFactory
         private readonly IRepositoryMetadataProvider repositoryMetadataProvider;
         private readonly IBranchConfigurationCalculator branchConfigurationCalculator;
         private readonly IOptions<GitVersionOptions> options;
+        private readonly ICurrentBuildAgent buildAgent;
+        private readonly ILog log;
 
-        public GitVersionContextFactory(IConfigProvider configProvider, IRepositoryMetadataProvider repositoryMetadataProvider, IBranchConfigurationCalculator branchConfigurationCalculator, IOptions<GitVersionOptions> options)
+        public GitVersionContextFactory(IConfigProvider configProvider, IRepositoryMetadataProvider repositoryMetadataProvider, IBranchConfigurationCalculator branchConfigurationCalculator, IOptions<GitVersionOptions> options, ICurrentBuildAgent buildAgent, ILog log)
         {
             this.configProvider = configProvider ?? throw new ArgumentNullException(nameof(configProvider));
             this.repositoryMetadataProvider = repositoryMetadataProvider ?? throw new ArgumentNullException(nameof(repositoryMetadataProvider));
             this.branchConfigurationCalculator = branchConfigurationCalculator ?? throw new ArgumentNullException(nameof(branchConfigurationCalculator));
             this.options = options ?? throw new ArgumentNullException(nameof(options));
+            this.buildAgent = buildAgent;
+            this.log = log;
         }
 
         public GitVersionContext Create(GitVersionOptions gitVersionOptions)
         {
-            var targetBranch = repositoryMetadataProvider.GetTargetBranch(gitVersionOptions.RepositoryInfo.TargetBranch);
+            var currentBranch = gitVersionOptions.Settings.UseBuildAgentBranch
+                ? ResolveCurrentBranch()
+                : gitVersionOptions.RepositoryInfo.TargetBranch;
+
+            var targetBranch = repositoryMetadataProvider.GetTargetBranch(currentBranch);
             return Init(targetBranch, gitVersionOptions.RepositoryInfo.CommitId, gitVersionOptions.Settings.OnlyTrackedBranches);
         }
 
+        public string ResolveCurrentBranch()
+        {
+            var gitVersionOptions = options.Value;
+            var targetBranch = gitVersionOptions.RepositoryInfo.TargetBranch;
+            if (buildAgent == null)
+            {
+                return targetBranch;
+            }
+
+            var isDynamicRepository = !string.IsNullOrWhiteSpace(gitVersionOptions.RepositoryInfo.DynamicRepositoryClonePath);
+            var currentBranch = buildAgent.GetCurrentBranch(isDynamicRepository) ?? targetBranch;
+            log.Info("Branch from build environment: " + currentBranch);
+
+            return currentBranch;
+        }
+
         private GitVersionContext Init(Branch currentBranch, string commitId = null, bool onlyTrackedBranches = false)
         {
             if (currentBranch == null)

src/GitVersionCore/Extensions/StringExtensions.cs

@@ -108,6 +108,8 @@ public static bool ArgumentRequiresValue(this string argument, int argumentIndex
                 "nofetch",
                 "nonormalize",
                 "nocache",
+                "usebuildagentbranch",
+                "azurepipelines-setparamskipisoutput"
             };
 
             var argumentMightRequireValue = !booleanArguments.Contains(argument.Substring(1), StringComparer.OrdinalIgnoreCase);

src/GitVersionCore/Model/Settings.cs

@@ -6,5 +6,7 @@ public class Settings
         public bool NoCache;
         public bool NoNormalize;
         public bool OnlyTrackedBranches = false;
+        public bool UseBuildAgentBranch;
+        public bool AzurePipelinesSetParamSkipIsOutput;
     }
 }

src/GitVersionExe/ArgumentParser.cs

@@ -272,6 +272,18 @@ private static bool ParseSwitches(Arguments arguments, string name, string[] val
                 return true;
             }
 
+            if (name.IsSwitch("usebuildagentbranch"))
+            {
+                arguments.UseBuildAgentBranch = true;
+                return true;
+            }
+
+            if (name.IsSwitch("azurepipelines-setparamskipisoutput"))
+            {
+                arguments.AzurePipelinesSetParamSkipIsOutput = true;
+                return true;
+            }
+
             if (name.IsSwitch("verbosity"))
             {
                 ParseVerbosity(arguments, value);

src/GitVersionExe/Arguments.cs

@@ -30,6 +30,8 @@ public class Arguments
         public bool NoFetch;
         public bool NoCache;
         public bool NoNormalize;
+        public bool UseBuildAgentBranch;
+        public bool AzurePipelinesSetParamSkipIsOutput;
 
         public string LogFilePath;
         public string ShowVariable;
@@ -85,6 +87,8 @@ public GitVersionOptions ToOptions()
                     NoFetch = NoFetch,
                     NoCache = NoCache,
                     NoNormalize = NoNormalize,
+                    UseBuildAgentBranch = UseBuildAgentBranch,
+                    AzurePipelinesSetParamSkipIsOutput = AzurePipelinesSetParamSkipIsOutput,
                 },
 
                 WixInfo =

src/GitVersionExe/HelpWriter.cs

@@ -78,6 +78,12 @@ All the GitVersion variables are written to 'GitVersion_WixVersion.wxi'.
     /dynamicRepoLocation
                     By default dynamic repositories will be cloned to %tmp%. Use this switch to override
     /nofetch        Disables 'git fetch' during version calculation. Might cause GitVersion to not calculate your version as expected.
+    /usebuildagentbranch
+                    Forces the use of Build Agent branch if available as a starting point for calculating your version.
+                    Might cause GitVersion to not calculate your version as expected for transient branches.
+    /azurepipelines-setparamskipisoutput
+                    Azure Pipelines Build Agent Only.
+                    Forces variable outputs not to contain isoutput=true when setting params. This causes errors in certain TFS servers.
 
 # Execute build args
     /exec           Executes target executable making GitVersion variables available as environmental variables

src/GitVersionExe/Program.cs

@@ -35,16 +35,18 @@ private IHostBuilder CreateHostBuilder(string[] args) =>
                 })
                 .ConfigureServices((hostContext, services) =>
                 {
-                    services.AddModule(new GitVersionCoreModule());
-                    services.AddModule(new GitVersionExeModule());
-
                     services.AddSingleton(sp =>
                     {
                         var arguments = sp.GetService<IArgumentParser>().ParseArguments(args);
                         var gitVersionOptions = arguments.ToOptions();
                         return Options.Create(gitVersionOptions);
                     });
 
+                    services.AddSingleton<Func<GitVersionOptions>>(sp => () => sp.GetRequiredService<IOptions<GitVersionOptions>>().Value);
+
+                    services.AddModule(new GitVersionCoreModule());
+                    services.AddModule(new GitVersionExeModule());
+
                     overrides?.Invoke(services);
                     services.AddHostedService<GitVersionApp>();
                 })

src/GitVersionTask.MsBuild/GitVersionTaskBase.cs

@@ -22,6 +22,10 @@ protected GitVersionTaskBase()
 
         public bool NoNormalize { get; set; }
 
+        public bool UseBuildAgentBranch { get; set; }
+
+        public bool AzurePipelinesSetParamSkipIsOutput { get; set; }
+
         public TaskLoggingHelper Log { get; }
 
         public bool Execute()

src/GitVersionTask/GitVersionTasks.cs

@@ -69,7 +69,9 @@ private static IServiceProvider BuildServiceProvider(GitVersionTaskBase task)
                 Settings =
                 {
                     NoFetch = task.NoFetch,
-                    NoNormalize = task.NoNormalize
+                    NoNormalize = task.NoNormalize,
+                    UseBuildAgentBranch = task.UseBuildAgentBranch,
+                    AzurePipelinesSetParamSkipIsOutput = task.AzurePipelinesSetParamSkipIsOutput
                 }
             };