Merge pull request #323 from firegiant/318-semver1-warning

Emit a warning when SemVer 2.0 format version is used with explicit SemVer 1.0

Author: AArnott

src/NerdBank.GitVersioning.Tests/NerdBank.GitVersioning.Tests.csproj

@@ -9,7 +9,7 @@
     <IsTestProject>true</IsTestProject>
   </PropertyGroup>
   <ItemGroup>
-    <Compile Include="..\Nerdbank.GitVersioning\SemanticVersionExtensions.cs" />
+    <Compile Include="..\Shared\**\*.cs" LinkBase="Shared" />
   </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="..\Nerdbank.GitVersioning.Tasks\build\Nerdbank.GitVersioning.targets">

src/NerdBank.GitVersioning/VersionOracle.cs

@@ -14,11 +14,6 @@
     /// </summary>
     public class VersionOracle
     {
-        /// <summary>
-        /// A regex that matches on numeric identifiers for prerelease or build metadata.
-        /// </summary>
-        private static readonly Regex NumericIdentifierRegex = new Regex(@"(?<![\w-])(\d+)(?![\w-])");
-
         /// <summary>
         /// The 0.0 version.
         /// </summary>
@@ -178,7 +173,7 @@ public IEnumerable<string> BuildMetadataWithCommitId
         /// <summary>
         /// Gets the version options used to initialize this instance.
         /// </summary>
-        private VersionOptions VersionOptions { get; }
+        public VersionOptions VersionOptions { get; }
 
         /// <summary>
         /// Gets the version string to use for the <see cref="System.Reflection.AssemblyVersionAttribute"/>.
@@ -427,7 +422,7 @@ public IDictionary<string, string> CloudBuildVersionVars
         private string SemVer2BuildMetadata =>
             (this.PublicRelease ? string.Empty : this.GitCommitIdShortForNonPublicPrereleaseTag) + FormatBuildMetadata(this.BuildMetadata);
 
-        private string PrereleaseVersionSemVer1 => MakePrereleaseSemVer1Compliant(this.PrereleaseVersion, this.SemVer1NumericIdentifierPadding);
+        private string PrereleaseVersionSemVer1 => SemanticVersionExtensions.MakePrereleaseSemVer1Compliant(this.PrereleaseVersion, this.SemVer1NumericIdentifierPadding);
 
         private string GitCommitIdShortForNonPublicPrereleaseTag => (string.IsNullOrEmpty(this.PrereleaseVersion) ? "-" : ".") + this.GitCommitIdShort;
 
@@ -464,32 +459,6 @@ private static Version GetAssemblyVersion(Version version, VersionOptions versio
         /// <returns>The specified string, with macros substituted for actual values.</returns>
         private string ReplaceMacros(string prereleaseOrBuildMetadata) => prereleaseOrBuildMetadata?.Replace("{height}", this.VersionHeightWithOffset.ToString(CultureInfo.InvariantCulture));
 
-        /// <summary>
-        /// Converts a semver 2 compliant "-beta.5" prerelease tag to a semver 1 compatible one.
-        /// </summary>
-        /// <param name="prerelease">The semver 2 prerelease tag, including its leading hyphen.</param>
-        /// <param name="paddingSize">The minimum number of digits to use for any numeric identifier.</param>
-        /// <returns>A semver 1 compliant prerelease tag. For example "-beta-0005".</returns>
-        private static string MakePrereleaseSemVer1Compliant(string prerelease, int paddingSize)
-        {
-            if (string.IsNullOrEmpty(prerelease))
-            {
-                return prerelease;
-            }
-
-            string paddingFormatter = "{0:" + new string('0', paddingSize) + "}";
-
-            string semver1 = prerelease;
-
-            // Identify numeric identifiers and pad them.
-            Assumes.True(prerelease.StartsWith("-"));
-            semver1 = "-" + NumericIdentifierRegex.Replace(semver1.Substring(1), m => string.Format(CultureInfo.InvariantCulture, paddingFormatter, int.Parse(m.Groups[1].Value)));
-
-            semver1 = semver1.Replace('.', '-');
-
-            return semver1;
-        }
-
         private static int CalculateVersionHeight(string relativeRepoProjectDirectory, LibGit2Sharp.Commit headCommit, VersionOptions committedVersion, VersionOptions workingVersion)
         {
             var headCommitVersion = committedVersion?.Version?.Version ?? Version0;

src/Nerdbank.GitVersioning.Tasks/GetBuildVersion.cs

@@ -212,6 +212,11 @@ protected override bool ExecuteInner()
                     oracle.BuildMetadata.AddRange(this.BuildMetadata);
                 }
 
+                if (IsMisconfiguredPrereleaseAndSemVer1(oracle))
+                {
+                    this.Log.LogWarning("The 'nugetPackageVersion' is explicitly set to 'semVer': 1 but the prerelease version '{0}' is not SemVer1 compliant. Change the 'nugetPackageVersion'.'semVer' value to 2 or change the 'version' member to follow SemVer1 rules (e.g.: '{1}').", oracle.PrereleaseVersion, GetSemVer1WithoutPaddingOrBuildMetadata(oracle));
+                }
+
                 this.PublicRelease = oracle.PublicRelease;
                 this.Version = oracle.Version.ToString();
                 this.AssemblyVersion = oracle.AssemblyVersion.ToString();
@@ -267,5 +272,23 @@ protected override bool ExecuteInner()
                 return false;
             }
         }
+
+        /// <summary>
+        /// Gets the SemVer v1 format without padding or the build metadata.
+        /// </summary>
+        private static string GetSemVer1WithoutPaddingOrBuildMetadata(VersionOracle oracle)
+        {
+            Requires.NotNull(oracle, nameof(oracle));
+            return $"{oracle.Version.ToStringSafe(3)}{SemanticVersionExtensions.MakePrereleaseSemVer1Compliant(oracle.PrereleaseVersion, 0)}";
+        }
+
+        /// <summary>
+        /// Gets a value indicating whether the user wants SemVer v1 compliance yet specified a non-v1 compliant prerelease tag.
+        /// </summary>
+        private static bool IsMisconfiguredPrereleaseAndSemVer1(VersionOracle oracle)
+        {
+            Requires.NotNull(oracle, nameof(oracle));
+            return oracle.VersionOptions?.NuGetPackageVersion?.SemVer == 1 && oracle.PrereleaseVersion != SemanticVersionExtensions.MakePrereleaseSemVer1Compliant(oracle.PrereleaseVersion, 0);
+        }
     }
 }

…tVersioning/SemanticVersionExtensions.cs src/Shared/SemanticVersionExtensions.cssrc/NerdBank.GitVersioning/SemanticVersionExtensions.cs renamed to src/Shared/SemanticVersionExtensions.cs src/NerdBank.GitVersioning/SemanticVersionExtensions.cs renamed to src/Shared/SemanticVersionExtensions.cs

@@ -1,13 +1,20 @@
 namespace Nerdbank.GitVersioning
 {
     using System;
+    using System.Globalization;
+    using System.Text.RegularExpressions;
     using Validation;
 
     /// <summary>
     /// Extension methods for <see cref="SemanticVersion"/>
     /// </summary>
     internal static class SemanticVersionExtensions
     {
+        /// <summary>
+        /// A regex that matches on numeric identifiers for prerelease or build metadata.
+        /// </summary>
+        private static readonly Regex NumericIdentifierRegex = new Regex(@"(?<![\w-])(\d+)(?![\w-])");
+
         /// <summary>
         /// Gets a new semantic with the specified version component (major/minor) incremented.
         /// </summary>
@@ -107,5 +114,31 @@ internal static SemanticVersion WithoutPrepreleaseTags(this SemanticVersion vers
         {
             return new SemanticVersion(version.Version, null, version.BuildMetadata);
         }
+
+        /// <summary>
+        /// Converts a semver 2 compliant "-beta.5" prerelease tag to a semver 1 compatible one.
+        /// </summary>
+        /// <param name="prerelease">The semver 2 prerelease tag, including its leading hyphen.</param>
+        /// <param name="paddingSize">The minimum number of digits to use for any numeric identifier.</param>
+        /// <returns>A semver 1 compliant prerelease tag. For example "-beta-0005".</returns>
+        internal static string MakePrereleaseSemVer1Compliant(string prerelease, int paddingSize)
+        {
+            if (string.IsNullOrEmpty(prerelease))
+            {
+                return prerelease;
+            }
+
+            string paddingFormatter = "{0:" + new string('0', paddingSize) + "}";
+
+            string semver1 = prerelease;
+
+            // Identify numeric identifiers and pad them.
+            Assumes.True(prerelease.StartsWith("-"));
+            semver1 = "-" + NumericIdentifierRegex.Replace(semver1.Substring(1), m => string.Format(CultureInfo.InvariantCulture, paddingFormatter, int.Parse(m.Groups[1].Value)));
+
+            semver1 = semver1.Replace('.', '-');
+
+            return semver1;
+        }
     }
 }