[Azure DevOps] Leave the original Build Number when no GitVersion variable in Build Number

docs/input/docs/configuration.md

@@ -213,6 +213,10 @@ Sets the format which will be used to format the `CommitDate` output variable.
 
 The header for ignore configuration.
 
+### update-build-number
+
+Configures GitVersion to update the build number or not when running on a build server.
+
 #### sha
 
 A sequence of SHAs to be excluded from the version calculations. Useful when

src/GitVersionCore.Tests/BuildAgents/BuildServerBaseTests.cs

@@ -50,6 +50,10 @@ public void BuildNumberIsFullSemVer()
             buildServer.WriteIntegration(writes.Add, variables);
 
             writes[1].ShouldBe("1.2.3-beta.1+5");
+
+            writes = new List<string>();
+            buildServer.WriteIntegration(writes.Add, variables, false);
+            writes.ShouldBeEmpty();
         }
 
         private class BuildAgent : BuildAgentBase

src/GitVersionCore.Tests/BuildAgents/GitHubActionsTests.cs

@@ -148,6 +148,23 @@ public void ShouldWriteIntegration()
                 .ShouldBe(string.Join(Environment.NewLine, expected));
         }
 
+        [Test]
+        public void ShouldNotWriteIntegration()
+        {
+            // Arrange
+            var vars = new TestableVersionVariables("1.0.0");
+
+            var list = new List<string>();
+
+            // Assert
+            environment.GetEnvironmentVariable("GitVersion_Major").ShouldBeNullOrWhiteSpace();
+
+            // Act
+            buildServer.WriteIntegration(s => { list.Add(s); }, vars, false);
+
+            list.ShouldBeEmpty();
+        }
+
         [Test]
         public void GetEmptyGenerateSetVersionMessage()
         {

src/GitVersionCore.Tests/Configuration/ConfigProviderTests.CanWriteOutEffectiveConfiguration.approved.txt

@@ -123,3 +123,4 @@ ignore:
   sha: []
 commit-date-format: yyyy-MM-dd
 merge-message-formats: {}
+update-build-number: true

src/GitVersionCore.Tests/Helpers/TestEffectiveConfiguration.cs

@@ -35,14 +35,15 @@ public TestEffectiveConfiguration(
             IEnumerable<IVersionFilter> versionFilters = null,
             bool tracksReleaseBranches = false,
             bool isRelease = false,
-            string commitDateFormat = "yyyy-MM-dd") :
+            string commitDateFormat = "yyyy-MM-dd",
+            bool updateBuildNumber = false) :
             base(assemblyVersioningScheme, assemblyFileVersioningScheme, assemblyInformationalFormat, assemblyVersioningFormat, assemblyFileVersioningFormat, versioningMode, gitTagPrefix, tag, nextVersion, IncrementStrategy.Patch,
                     branchPrefixToTrim, preventIncrementForMergedBranchVersion, tagNumberPattern, continuousDeploymentFallbackTag,
                     trackMergeTarget,
                     majorMessage, minorMessage, patchMessage, noBumpMessage,
                     commitMessageMode, legacySemVerPadding, buildMetaDataPadding, commitsSinceVersionSourcePadding,
                     versionFilters ?? Enumerable.Empty<IVersionFilter>(),
-                    tracksReleaseBranches, isRelease, commitDateFormat, 0)
+                    tracksReleaseBranches, isRelease, commitDateFormat, updateBuildNumber, 0)
         {
         }
     }

src/GitVersionCore.Tests/Model/CommitDateTests.cs

@@ -29,7 +29,7 @@ public void CommitDateFormatTest(string format, string expectedOutcome)
                                     },
                                     new EffectiveConfiguration(
                                         AssemblyVersioningScheme.MajorMinorPatch, AssemblyFileVersioningScheme.MajorMinorPatch, "", "", "", VersioningMode.ContinuousDelivery, "", "", "", IncrementStrategy.Inherit,
-                                        "", true, "", "", false, "", "", "", "", CommitMessageIncrementMode.Enabled, 4, 4, 4, Enumerable.Empty<IVersionFilter>(), false, true, format, 0)
+                                        "", true, "", "", false, "", "", "", "", CommitMessageIncrementMode.Enabled, 4, 4, 4, Enumerable.Empty<IVersionFilter>(), false, true, format, false, 0)
                                 );
 
             Assert.That(formatValues.CommitDate, Is.EqualTo(expectedOutcome));

src/GitVersionCore/BuildAgents/CodeBuild.cs

@@ -40,7 +40,7 @@ public override string GetCurrentBranch(bool usingDynamicRepos)
             return Environment.GetEnvironmentVariable(EnvironmentVariableName);
         }
 
-        public override void WriteIntegration(Action<string> writer, VersionVariables variables)
+        public override void WriteIntegration(Action<string> writer, VersionVariables variables, bool updateBuildNumber = true)
         {
             base.WriteIntegration(writer, variables);
             writer($"Outputting variables to '{file}' ... ");

src/GitVersionCore/BuildAgents/GitLabCi.cs

@@ -43,7 +43,7 @@ public override string GetCurrentBranch(bool usingDynamicRepos)
 
         public override bool PreventFetch() => true;
 
-        public override void WriteIntegration(Action<string> writer, VersionVariables variables)
+        public override void WriteIntegration(Action<string> writer, VersionVariables variables, bool updateBuildNumber = true)
         {
             base.WriteIntegration(writer, variables);
             writer($"Outputting variables to '{file}' ... ");

src/GitVersionCore/BuildAgents/Jenkins.cs

@@ -58,7 +58,7 @@ public override bool ShouldCleanUpRemotes()
             return IsPipelineAsCode();
         }
 
-        public override void WriteIntegration(Action<string> writer, VersionVariables variables)
+        public override void WriteIntegration(Action<string> writer, VersionVariables variables, bool updateBuildNumber = true)
         {
             base.WriteIntegration(writer, variables);
             writer($"Outputting variables to '{file}' ... ");

src/GitVersionCore/Common/IBuildAgent.cs

@@ -6,7 +6,7 @@ namespace GitVersion
     public interface IBuildAgent
     {
         bool CanApplyToCurrentContext();
-        void WriteIntegration(Action<string> writer, VersionVariables variables);
+        void WriteIntegration(Action<string> writer, VersionVariables variables, bool updateBuildNumber = true);
         string GetCurrentBranch(bool usingDynamicRepos);
         bool PreventFetch();
         bool ShouldCleanUpRemotes();

src/GitVersionCore/Configuration/ConfigExtensions.cs

@@ -36,6 +36,7 @@ public static void Reset(this Config config)
             config.BuildMetaDataPadding ??= 4;
             config.CommitsSinceVersionSourcePadding ??= 4;
             config.CommitDateFormat ??= "yyyy-MM-dd";
+            config.UpdateBuildNumber ??= true;
 
             var configBranches = config.Branches.ToList();
 
@@ -263,6 +264,7 @@ public static EffectiveConfiguration CalculateEffectiveConfiguration(this Config
             var patchMessage = configuration.PatchVersionBumpMessage;
             var noBumpMessage = configuration.NoBumpMessage;
             var commitDateFormat = configuration.CommitDateFormat;
+            var updateBuildNumber = configuration.UpdateBuildNumber ?? true;
 
             var commitMessageVersionBump = currentBranchConfig.CommitMessageIncrementing ?? configuration.CommitMessageIncrementing.Value;
 
@@ -282,6 +284,7 @@ public static EffectiveConfiguration CalculateEffectiveConfiguration(this Config
                 currentBranchConfig.TracksReleaseBranches.Value,
                 currentBranchConfig.IsReleaseBranch.Value,
                 commitDateFormat,
+                updateBuildNumber,
                 preReleaseWeight);
         }
 

src/GitVersionCore/Core/BuildAgentBase.cs

@@ -28,9 +28,9 @@ protected BuildAgentBase(IEnvironment environment, ILog log)
         public virtual bool PreventFetch() => true;
         public virtual bool ShouldCleanUpRemotes() => false;
 
-        public virtual void WriteIntegration(Action<string> writer, VersionVariables variables)
+        public virtual void WriteIntegration(Action<string> writer, VersionVariables variables, bool updateBuildNumber = true)
         {
-            if (writer == null)
+            if (writer == null || !updateBuildNumber)
             {
                 return;
             }

src/GitVersionCore/Model/Configuration/Config.cs

@@ -118,14 +118,15 @@ private static T MergeObjects<T>(T target, T source)
         [YamlMember(Alias = "merge-message-formats")]
         public Dictionary<string, string> MergeMessageFormats { get; set; } = new Dictionary<string, string>();
 
+        [YamlMember(Alias = "update-build-number")]
+        public bool? UpdateBuildNumber { get; set; }
+
         public override string ToString()
         {
             var stringBuilder = new StringBuilder();
-            using (var stream = new StringWriter(stringBuilder))
-            {
-                ConfigSerializer.Write(this, stream);
-                stream.Flush();
-            }
+            using var stream = new StringWriter(stringBuilder);
+            ConfigSerializer.Write(this, stream);
+            stream.Flush();
             return stringBuilder.ToString();
         }
 

src/GitVersionCore/Model/Configuration/EffectiveConfiguration.cs

@@ -34,6 +34,7 @@ public EffectiveConfiguration(
             bool tracksReleaseBranches,
             bool isCurrentBranchRelease,
             string commitDateFormat,
+            bool updateBuildNumber,
             int preReleaseWeight)
         {
             AssemblyVersioningScheme = assemblyVersioningScheme;
@@ -63,6 +64,7 @@ public EffectiveConfiguration(
             TracksReleaseBranches = tracksReleaseBranches;
             IsCurrentBranchRelease = isCurrentBranchRelease;
             CommitDateFormat = commitDateFormat;
+            UpdateBuildNumber = updateBuildNumber;
             PreReleaseWeight = preReleaseWeight;
         }
 
@@ -119,6 +121,8 @@ public EffectiveConfiguration(
 
         public string CommitDateFormat { get; private set; }
 
+        public bool UpdateBuildNumber { get; private set; }
+
         public int PreReleaseWeight { get; private set; }
     }
 }

src/GitVersionCore/VersionConverters/OutputGenerator/OutputGenerator.cs

@@ -15,13 +15,15 @@ public class OutputGenerator : IOutputGenerator
         private readonly IConsole console;
         private readonly IFileSystem fileSystem;
         private readonly IOptions<GitVersionOptions> options;
+        private readonly Lazy<GitVersionContext> versionContext;
         private readonly ICurrentBuildAgent buildAgent;
 
-        public OutputGenerator(ICurrentBuildAgent buildAgent, IConsole console, IFileSystem fileSystem, IOptions<GitVersionOptions> options)
+        public OutputGenerator(ICurrentBuildAgent buildAgent, IConsole console, IFileSystem fileSystem, IOptions<GitVersionOptions> options, Lazy<GitVersionContext> versionContext)
         {
             this.console = console ?? throw new ArgumentNullException(nameof(console));
             this.fileSystem = fileSystem ?? throw new ArgumentNullException(nameof(fileSystem));
             this.options = options ?? throw new ArgumentNullException(nameof(options));
+            this.versionContext = versionContext;
             this.buildAgent = buildAgent;
         }
 
@@ -30,7 +32,7 @@ public void Execute(VersionVariables variables, OutputContext context)
             var gitVersionOptions = options.Value;
             if (gitVersionOptions.Output.Contains(OutputType.BuildServer))
             {
-                buildAgent?.WriteIntegration(console.WriteLine, variables);
+                buildAgent?.WriteIntegration(console.WriteLine, variables, versionContext.Value.Configuration.UpdateBuildNumber);
             }
             if (gitVersionOptions.Output.Contains(OutputType.File))
             {