Merge pull request #137 from robmen/136-overrideoffset

Allow BuildNumberOffset to be overridden via MSBuild

Author: AArnott

src/NerdBank.GitVersioning.Tests/BuildIntegrationTests.cs

@@ -382,6 +382,21 @@ public async Task GetBuildVersion_CustomBuildNumberOffset()
         this.AssertStandardProperties(versionOptions, buildResult);
     }
 
+    [Fact]
+    public async Task GetBuildVersion_OverrideBuildNumberOffset()
+    {
+        this.WriteVersionFile("14.0");
+        this.InitializeSourceControl();
+        var versionOptions = new VersionOptions
+        {
+            Version = new SemanticVersion(new Version(14, 1))
+        };
+        this.WriteVersionFile(versionOptions);
+        this.testProject.AddProperty("OverrideBuildNumberOffset", "10");
+        var buildResult = await this.BuildAsync();
+        Assert.Equal("14.1.11.31122", buildResult.AssemblyFileVersion);
+    }
+
     [Fact]
     public async Task GetBuildVersion_Minus1BuildOffset_NotYetCommitted()
     {

src/NerdBank.GitVersioning/VersionOracle.cs

@@ -29,8 +29,9 @@ public class VersionOracle
         /// <param name="projectDirectory"></param>
         /// <param name="gitRepoDirectory"></param>
         /// <param name="cloudBuild"></param>
+        /// <param name="overrideBuildNumberOffset"></param>
         /// <returns></returns>
-        public static VersionOracle Create(string projectDirectory, string gitRepoDirectory = null, ICloudBuild cloudBuild = null)
+        public static VersionOracle Create(string projectDirectory, string gitRepoDirectory = null, ICloudBuild cloudBuild = null, int? overrideBuildNumberOffset = null)
         {
             Requires.NotNull(projectDirectory, nameof(projectDirectory));
             if (string.IsNullOrEmpty(gitRepoDirectory))
@@ -40,14 +41,14 @@ public static VersionOracle Create(string projectDirectory, string gitRepoDirect
 
             using (var git = OpenGitRepo(gitRepoDirectory))
             {
-                return new VersionOracle(projectDirectory, git, cloudBuild);
+                return new VersionOracle(projectDirectory, git, cloudBuild, overrideBuildNumberOffset);
             }
         }
 
         /// <summary>
         /// Initializes a new instance of the <see cref="VersionOracle"/> class.
         /// </summary>
-        public VersionOracle(string projectDirectory, LibGit2Sharp.Repository repo, ICloudBuild cloudBuild)
+        public VersionOracle(string projectDirectory, LibGit2Sharp.Repository repo, ICloudBuild cloudBuild, int? overrideBuildNumberOffset = null)
         {
             var repoRoot = repo?.Info?.WorkingDirectory?.TrimEnd(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar);
             var relativeRepoProjectDirectory = !string.IsNullOrWhiteSpace(repoRoot)
@@ -60,6 +61,19 @@ public VersionOracle(string projectDirectory, LibGit2Sharp.Repository repo, IClo
 
             var workingVersion = VersionFile.GetVersion(projectDirectory);
 
+            if (overrideBuildNumberOffset.HasValue)
+            {
+                if (committedVersion != null)
+                {
+                    committedVersion.BuildNumberOffset = overrideBuildNumberOffset.Value;
+                }
+
+                if (workingVersion != null)
+                {
+                    workingVersion.BuildNumberOffset = overrideBuildNumberOffset.Value;
+                }
+            }
+
             this.VersionOptions = committedVersion ?? workingVersion;
 
             this.GitCommitId = commit?.Id.Sha ?? cloudBuild?.GitCommitId ?? null;

src/Nerdbank.GitVersioning.NuGet/build/Nerdbank.GitVersioning.targets

@@ -60,6 +60,7 @@
       BuildMetadata="@(BuildMetadata)"
       DefaultPublicRelease="$(PublicRelease)"
       GitRepoRoot="$(GitRepoRoot)"
+      OverrideBuildNumberOffset="$(OverrideBuildNumberOffset)"
       TargetsPath="$(MSBuildThisFileDirectory)">
 
       <Output TaskParameter="Version" PropertyName="BuildVersion" />

src/Nerdbank.GitVersioning.Tasks/GetBuildVersion.cs

@@ -40,6 +40,11 @@ public GetBuildVersion()
         /// </summary>
         public string GitRepoRoot { get; set; }
 
+        /// <summary>
+        /// Gets or sets the optional override build number offset.
+        /// </summary>
+        public int OverrideBuildNumberOffset { get; set; } = int.MaxValue;
+
         /// <summary>
         /// Gets or sets the path to the folder that contains the NB.GV .targets file.
         /// </summary>
@@ -156,7 +161,8 @@ protected override bool ExecuteInner()
             try
             {
                 var cloudBuild = CloudBuild.Active;
-                var oracle = VersionOracle.Create(Directory.GetCurrentDirectory(), this.GitRepoRoot, cloudBuild);
+                var overrideBuildNumberOffset = (this.OverrideBuildNumberOffset == int.MaxValue) ? (int?)null : this.OverrideBuildNumberOffset;
+                var oracle = VersionOracle.Create(Directory.GetCurrentDirectory(), this.GitRepoRoot, cloudBuild, overrideBuildNumberOffset);
                 if (!string.IsNullOrEmpty(this.DefaultPublicRelease))
                 {
                     oracle.PublicRelease = string.Equals(this.DefaultPublicRelease, "true", StringComparison.OrdinalIgnoreCase);