Merge pull request #276 from AArnott/fix275

Add NuGet-semver v1 compatible version as ChocolateyPackageVersion

Author: AArnott

src/NerdBank.GitVersioning.Tests/BuildIntegrationTests.cs

@@ -945,16 +945,25 @@ private void AssertStandardProperties(VersionOptions versionOptions, BuildResult
         Assert.Equal(versionOptions.Version.Prerelease, buildResult.PrereleaseVersion);
         Assert.Equal(expectedBuildMetadata, buildResult.SemVerBuildSuffix);
 
-        // NuGet is now SemVer 2.0 and will pass additional build metadata if provided
-        bool semVer2 = versionOptions?.NuGetPackageVersionOrDefault.SemVer == 2;
-        string semVer1CommitPrefix = semVer2 ? string.Empty : "g";
-        string pkgVersionSuffix = buildResult.PublicRelease ? string.Empty : $"-{semVer1CommitPrefix}{commitIdShort}";
-        if (semVer2)
+        string GetPkgVersionSuffix(bool useSemVer2)
         {
-            pkgVersionSuffix += expectedBuildMetadataWithoutCommitId;
+            string semVer1CommitPrefix = useSemVer2 ? string.Empty : "g";
+            string pkgVersionSuffix = buildResult.PublicRelease ? string.Empty : $"-{semVer1CommitPrefix}{commitIdShort}";
+            if (useSemVer2)
+            {
+                pkgVersionSuffix += expectedBuildMetadataWithoutCommitId;
+            }
+
+            return pkgVersionSuffix;
         }
 
-        Assert.Equal($"{idAsVersion.Major}.{idAsVersion.Minor}.{idAsVersion.Build}{GetSemVerAppropriatePrereleaseTag(versionOptions)}{pkgVersionSuffix}", buildResult.NuGetPackageVersion);
+        // NuGet is now SemVer 2.0 and will pass additional build metadata if provided
+        string nugetPkgVersionSuffix = GetPkgVersionSuffix(useSemVer2: versionOptions?.NuGetPackageVersionOrDefault.SemVer == 2);
+        Assert.Equal($"{idAsVersion.Major}.{idAsVersion.Minor}.{idAsVersion.Build}{GetSemVerAppropriatePrereleaseTag(versionOptions)}{nugetPkgVersionSuffix}", buildResult.NuGetPackageVersion);
+
+        // Chocolatey only supports SemVer 1.0
+        string chocolateyPkgVersionSuffix = GetPkgVersionSuffix(useSemVer2: false);
+        Assert.Equal($"{idAsVersion.Major}.{idAsVersion.Minor}.{idAsVersion.Build}{GetSemVerAppropriatePrereleaseTag(versionOptions)}{chocolateyPkgVersionSuffix}", buildResult.ChocolateyPackageVersion);
 
         var buildNumberOptions = versionOptions.CloudBuildOrDefault.BuildNumberOrDefault;
         if (buildNumberOptions.EnabledOrDefault)
@@ -1137,6 +1146,7 @@ internal BuildResults(BuildResult buildResult, IReadOnlyList<BuildEventArgs> log
         public string AssemblyFileVersion => this.BuildResult.ProjectStateAfterBuild.GetPropertyValue("AssemblyFileVersion");
         public string AssemblyVersion => this.BuildResult.ProjectStateAfterBuild.GetPropertyValue("AssemblyVersion");
         public string NuGetPackageVersion => this.BuildResult.ProjectStateAfterBuild.GetPropertyValue("NuGetPackageVersion");
+        public string ChocolateyPackageVersion => this.BuildResult.ProjectStateAfterBuild.GetPropertyValue("ChocolateyPackageVersion");
         public string CloudBuildNumber => this.BuildResult.ProjectStateAfterBuild.GetPropertyValue("CloudBuildNumber");
         public string AssemblyName => this.BuildResult.ProjectStateAfterBuild.GetPropertyValue("AssemblyName");
         public string AssemblyTitle => this.BuildResult.ProjectStateAfterBuild.GetPropertyValue("AssemblyTitle");

src/NerdBank.GitVersioning.Tests/VersionOracleTests.cs

@@ -177,6 +177,7 @@ public void SemVerStableNonPublicVersion()
         Assert.True(Regex.IsMatch(oracle.SemVer1, @"^2.3.1-[^g]{10}$"));
         Assert.True(Regex.IsMatch(oracle.SemVer2, @"^2.3.1-[^g]{10}$"));
         Assert.True(Regex.IsMatch(oracle.NuGetPackageVersion, @"^2.3.1-g[a-f0-9]{10}$"));
+        Assert.True(Regex.IsMatch(oracle.ChocolateyPackageVersion, @"^2.3.1-g[a-f0-9]{10}$"));
     }
 
     [Fact]

src/NerdBank.GitVersioning/VersionOracle.cs

@@ -337,6 +337,14 @@ public IDictionary<string, string> CloudBuildVersionVars
         /// </summary>
         public string NuGetPackageVersion => this.VersionOptions?.NuGetPackageVersionOrDefault.SemVerOrDefault == 1 ? this.NuGetSemVer1 : this.SemVer2;
 
+        /// <summary>
+        /// Gets the version to use for Chocolatey packages.
+        /// </summary>
+        /// <remarks>
+        /// This always returns the NuGet subset of SemVer 1.0.
+        /// </remarks>
+        public string ChocolateyPackageVersion => this.NuGetSemVer1;
+
         /// <summary>
         /// Gets the version to use for NPM packages.
         /// </summary>

src/Nerdbank.GitVersioning.Tasks/GetBuildVersion.cs

@@ -152,6 +152,9 @@ public GetBuildVersion()
         [Output]
         public string NuGetPackageVersion { get; private set; }
 
+        [Output]
+        public string ChocolateyPackageVersion { get; private set; }
+
         [Output]
         public string NpmPackageVersion { get; private set; }
 
@@ -214,6 +217,7 @@ protected override bool ExecuteInner()
                 this.BuildMetadataFragment = oracle.BuildMetadataFragment;
                 this.CloudBuildNumber = oracle.CloudBuildNumberEnabled ? oracle.CloudBuildNumber : null;
                 this.NuGetPackageVersion = oracle.NuGetPackageVersion;
+                this.ChocolateyPackageVersion = oracle.ChocolateyPackageVersion;
                 this.NpmPackageVersion = oracle.NpmPackageVersion;
 
                 IEnumerable<ITaskItem> cloudBuildVersionVars = null;

src/Nerdbank.GitVersioning.Tasks/build/Nerdbank.GitVersioning.targets

@@ -86,6 +86,7 @@
       <Output TaskParameter="CloudBuildNumber" PropertyName="CloudBuildNumber" Condition=" '$(CloudBuildNumber)' == '' "/>
       <Output TaskParameter="BuildMetadataFragment" PropertyName="SemVerBuildSuffix" />
       <Output TaskParameter="NuGetPackageVersion" PropertyName="NuGetPackageVersion" />
+      <Output TaskParameter="ChocolateyPackageVersion" PropertyName="ChocolateyPackageVersion" />
       <Output TaskParameter="NuGetPackageVersion" PropertyName="Version" />
       <Output TaskParameter="NuGetPackageVersion" PropertyName="PackageVersion" />
       <Output TaskParameter="NPMPackageVersion" PropertyName="NPMPackageVersion" />