include build metadata in informational version only

adamralph · Sep 24, 2023 · 8a852d1 · 8a852d1
1 parent 20e6cbd
commit 8a852d1
Show file tree

Hide file tree

Showing 10 changed files with 45 additions and 25 deletions.
diff --git a/MinVer/build/MinVer.targets b/MinVer/build/MinVer.targets
@@ -62,8 +62,10 @@
       <MinVerBuildMetadata Condition="$(MinVerVersion.Contains(`+`))">$(MinVerVersion.Split(`+`, 2)[1])</MinVerBuildMetadata>
       <AssemblyVersion>$(MinVerMajor).0.0.0</AssemblyVersion>
       <FileVersion>$(MinVerMajor).$(MinVerMinor).$(MinVerPatch).0</FileVersion>
-      <PackageVersion>$(MinVerVersion)</PackageVersion>
-      <Version>$(MinVerVersion)</Version>
+      <InformationalVersion>$(MinVerVersion)</InformationalVersion>
+      <PackageVersion>$(MinVerMajor).$(MinVerMinor).$(MinVerPatch)</PackageVersion>
+      <PackageVersion Condition="'$(MinVerPreRelease)' != ''">$(PackageVersion)-$(MinVerPreRelease)</PackageVersion>
+      <Version>$(PackageVersion)</Version>
     </PropertyGroup>
     <Message Importance="$(MinVerDetailed)" Text="MinVer: [output] MinVerVersion=$(MinVerVersion)" />
     <Message Importance="$(MinVerDetailed)" Text="MinVer: [output] MinVerMajor=$(MinVerMajor)" />
@@ -73,6 +75,7 @@
     <Message Importance="$(MinVerDetailed)" Text="MinVer: [output] MinVerBuildMetadata=$(MinVerBuildMetadata)" />
     <Message Importance="$(MinVerDetailed)" Text="MinVer: [output] AssemblyVersion=$(AssemblyVersion)" />
     <Message Importance="$(MinVerDetailed)" Text="MinVer: [output] FileVersion=$(FileVersion)" />
+    <Message Importance="$(MinVerDetailed)" Text="MinVer: [output] InformationalVersion=$(InformationalVersion)" />
     <Message Importance="$(MinVerDetailed)" Text="MinVer: [output] PackageVersion=$(PackageVersion)" />
     <Message Importance="$(MinVerDetailed)" Text="MinVer: [output] Version=$(Version)" />
   </Target>

diff --git a/MinVerTests.Infra/Package.cs b/MinVerTests.Infra/Package.cs
@@ -4,18 +4,18 @@
 
 namespace MinVerTests.Infra
 {
-    public record Package(string Version, AssemblyVersion AssemblyVersion, FileVersion FileVersion)
+    public record Package(string Version, AssemblyVersion AssemblyVersion, FileVersion FileVersion, string InformationalVersion)
     {
         public static Package WithVersion(int major, int minor, int patch, IEnumerable<string>? preReleaseIdentifiers = null, int height = 0, string buildMetadata = "", string? informationalVersionAdditionalBuildMetadata = "")
         {
             var preReleaseToken = preReleaseIdentifiers == null ? "" : GetPreReleaseToken(preReleaseIdentifiers.ToList());
             var heightToken = height == 0 ? "" : $".{height}";
             var buildMetadataToken = string.IsNullOrEmpty(buildMetadata) ? "" : $"+{buildMetadata}";
 
-            var version = $"{major}.{minor}.{patch}{preReleaseToken}{heightToken}{buildMetadataToken}";
-            var informationalVersion = $"{version}{informationalVersionAdditionalBuildMetadata}";
+            var version = $"{major}.{minor}.{patch}{preReleaseToken}{heightToken}";
+            var informationalVersion = $"{version}{buildMetadataToken}{informationalVersionAdditionalBuildMetadata}";
 
-            return new Package(version, new AssemblyVersion(major, 0, 0, 0), new FileVersion(major, minor, patch, 0, informationalVersion));
+            return new Package(version, new AssemblyVersion(major, 0, 0, 0), new FileVersion(major, minor, patch, 0, informationalVersion), informationalVersion);
         }
 
         private static string GetPreReleaseToken(IReadOnlyList<string> preReleaseIdentifiers) => preReleaseIdentifiers.Any() ? $"-{string.Join(".", preReleaseIdentifiers)}" : "";

diff --git a/MinVerTests.Infra/Sdk.cs b/MinVerTests.Infra/Sdk.cs
@@ -5,6 +5,7 @@
 using System.IO;
 using System.IO.Compression;
 using System.Linq;
+using System.Reflection;
 using System.Runtime.Loader;
 using System.Threading.Tasks;
 using Microsoft.Extensions.FileSystemGlobbing;
@@ -171,23 +172,26 @@ private static async Task<Package> GetPackage(string fileName)
 
             var assemblyFileName = Directory.EnumerateFiles(extractedDirectoryName, "*.dll", new EnumerationOptions { RecurseSubdirectories = true, }).First();
 
-            var systemAssemblyVersion = GetAssemblyVersion(assemblyFileName);
+            var (systemAssemblyVersion, informationalVersion) = GetAssemblyVersions(assemblyFileName);
             var assemblyVersion = new AssemblyVersion(systemAssemblyVersion.Major, systemAssemblyVersion.Minor, systemAssemblyVersion.Build, systemAssemblyVersion.Revision);
 
             var fileVersionInfo = FileVersionInfo.GetVersionInfo(assemblyFileName);
             var fileVersion = new FileVersion(fileVersionInfo.FileMajorPart, fileVersionInfo.FileMinorPart, fileVersionInfo.FileBuildPart, fileVersionInfo.FilePrivatePart, fileVersionInfo.ProductVersion ?? "");
 
-            return new Package(nuspecVersion, assemblyVersion, fileVersion);
+            return new Package(nuspecVersion, assemblyVersion, fileVersion, informationalVersion);
         }
 
-        private static Version GetAssemblyVersion(string assemblyFileName)
+        private static (Version Version, string InformationalVersion) GetAssemblyVersions(string assemblyFileName)
         {
             var assemblyLoadContext = new AssemblyLoadContext(default, true);
             var assembly = assemblyLoadContext.LoadFromAssemblyPath(assemblyFileName);
 
             try
             {
-                return assembly.GetName().Version ?? throw new InvalidOperationException("The assembly version is null.");
+                return (
+                    assembly.GetName().Version ?? throw new InvalidOperationException("The assembly version is null."),
+                    assembly.GetCustomAttributes().OfType<AssemblyInformationalVersionAttribute>().FirstOrDefault()?.InformationalVersion ??
+                        throw new InvalidOperationException("The assembly has no informational version."));
             }
             finally
             {

diff --git a/MinVerTests.Packages/AnnotatedTag.cs b/MinVerTests.Packages/AnnotatedTag.cs
@@ -26,6 +26,6 @@ public static async Task HasTagVersion()
 
         // assert
         Assert.Equal(expected, actual);
-        Assert.Equal(expected.Version, cliStandardOutput.Trim());
+        Assert.Equal(expected.InformationalVersion, cliStandardOutput.Trim());
     }
 }
diff --git a/MinVerTests.Packages/BuildMetadata.cs b/MinVerTests.Packages/BuildMetadata.cs
@@ -22,6 +22,6 @@ public static async Task HasBuildMetadata()
 
         // assert
         Assert.Equal(expected, actual);
-        Assert.Equal(expected.Version, cliStandardOutput.Trim());
+        Assert.Equal(expected.InformationalVersion, cliStandardOutput.Trim());
     }
 }
diff --git a/MinVerTests.Packages/OutputVariables.cs b/MinVerTests.Packages/OutputVariables.cs
@@ -28,7 +28,8 @@ public static async Task AreSet()
         Assert.Contains("MinVer: [output] MinVerBuildMetadata=build.6", standardOutput, StringComparison.Ordinal);
         Assert.Contains("MinVer: [output] AssemblyVersion=2.0.0.0", standardOutput, StringComparison.Ordinal);
         Assert.Contains("MinVer: [output] FileVersion=2.3.4.0", standardOutput, StringComparison.Ordinal);
-        Assert.Contains("MinVer: [output] PackageVersion=2.3.4-alpha-x.5+build.6", standardOutput, StringComparison.Ordinal);
-        Assert.Contains("MinVer: [output] Version=2.3.4-alpha-x.5+build.6", standardOutput, StringComparison.Ordinal);
+        Assert.Contains("MinVer: [output] InformationalVersion=2.3.4-alpha-x.5+build.6", standardOutput, StringComparison.Ordinal);
+        Assert.Contains("MinVer: [output] PackageVersion=2.3.4-alpha-x.5", standardOutput, StringComparison.Ordinal);
+        Assert.Contains("MinVer: [output] Version=2.3.4-alpha-x.5", standardOutput, StringComparison.Ordinal);
     }
 }
diff --git a/MinVerTests.Packages/SourceLink.cs b/MinVerTests.Packages/SourceLink.cs
@@ -23,7 +23,8 @@ public static async Task HasCommitSha()
         await Git.Commit(path);
         var sha = (await Git.GetCommitShas(path)).Single();
 
-        var envVars = ("MinVerBuildMetadata", "build.123");
+        var buildMetadata = "build.123";
+        var envVars = ("MinVerBuildMetadata", buildMetadata);
         var expected = Package.WithVersion(0, 0, 0, new[] { "alpha", "0", }, 0, $"build.123", $".{sha}");
 
         // act
@@ -32,6 +33,6 @@ public static async Task HasCommitSha()
 
         // assert
         Assert.Equal(expected, actual);
-        Assert.Equal(expected.Version, cliStandardOutput.Trim());
+        Assert.Equal($"{expected.Version}+{buildMetadata}", cliStandardOutput.Trim());
     }
 }
diff --git a/MinVerTests.Packages/TagWithBuildMetadata.cs b/MinVerTests.Packages/TagWithBuildMetadata.cs
@@ -26,6 +26,6 @@ public static async Task HasTagVersion()
 
         // assert
         Assert.Equal(expected, actual);
-        Assert.Equal(expected.Version, cliStandardOutput.Trim());
+        Assert.Equal(expected.InformationalVersion, cliStandardOutput.Trim());
     }
 }
diff --git a/MinVerTests.Packages/VersionOverride.cs b/MinVerTests.Packages/VersionOverride.cs
@@ -28,6 +28,6 @@ public static async Task HasVersionOverride()
 
         // assert
         Assert.Equal(expected, actual);
-        Assert.Equal(expected.Version, cliStandardOutput.Trim());
+        Assert.Equal(expected.InformationalVersion, cliStandardOutput.Trim());
     }
 }
diff --git a/README.md b/README.md
@@ -89,12 +89,13 @@ MinVer sets the following custom properties:
 
 Those properties are used to set the following .NET SDK properties, satisfying the official [open-source library guidance for version numbers](https://docs.microsoft.com/en-ca/dotnet/standard/library-guidance/versioning#version-numbers):
 
-| Property          | Value                                         |
-| ----------------- | --------------------------------------------- |
-| `AssemblyVersion` | `{MinVerMajor}.0.0.0`                         |
-| `FileVersion`     | `{MinVerMajor}.{MinVerMinor}.{MinVerPatch}.0` |
-| `PackageVersion`  | `{MinVerVersion}`                             |
-| `Version`         | `{MinVerVersion}`                             |
+| Property               | Value                                                                                                           |
+|------------------------|-----------------------------------------------------------------------------------------------------------------|
+| `AssemblyVersion`      | `{MinVerMajor}.0.0.0`                                                                                           |
+| `FileVersion`          | `{MinVerMajor}.{MinVerMinor}.{MinVerPatch}.0`                                                                   |
+| `InformationalVersion` | `{MinVerVersion}`                                                                                               |
+| `PackageVersion`       | `{MinVerMajor}.{MinVerMinor}.{MinVerPatch}` (or `{MinVerMajor}.{MinVerMinor}.{MinVerPatch}-{MinVerPreRelease}`) |
+| `Version`              | `{MinVerMajor}.{MinVerMinor}.{MinVerPatch}` (or `{MinVerMajor}.{MinVerMinor}.{MinVerPatch}-{MinVerPreRelease}`) |
 
 This behaviour can be [customised](#can-i-use-the-version-calculated-by-minver-for-other-purposes).
 
@@ -249,6 +250,17 @@ environment:
 
 You can also specify build metadata in a version tag. If the tag is on the current commit, its build metadata will be used. If the tag is on an older commit, its build metadata will be ignored. Build metadata in `MinVerBuildMetadata` will be appended to build metadata in the tag.
 
+Build metadata is only included in the [assembly informational version](https://learn.microsoft.com/en-us/dotnet/standard/library-guidance/versioning#assembly-informational-version). You can include it elsewhere using a custom target. E.g.:
+
+```xml
+<Target Name="MyTarget" AfterTargets="MinVer" Condition="'$(MinVerBuildMetadata)' != ''" >
+  <PropertyGroup>
+    <PackageVersion>$(PackageVersion)+$(MinVerBuildMetadata)</PackageVersion>
+    <Version>$(PackageVersion)</Version>
+  </PropertyGroup>
+</Target>
+```
+
 ### Can I auto-increment the minor or major version after an RTM tag instead of the patch version?
 
 Yes! Specify which part of the version to auto-increment with `MinVerAutoIncrement`. By default, [MinVer will auto-increment the patch version](#how-it-works), but you can specify `minor` or `major` to increment the minor or major version instead.
@@ -277,7 +289,6 @@ For example, for pull requests, you may want to inject the pull request number a
 <Target Name="MyTarget" AfterTargets="MinVer" Condition="'$(APPVEYOR_PULL_REQUEST_NUMBER)' != ''" >
   <PropertyGroup>
     <PackageVersion>$(MinVerMajor).$(MinVerMinor).$(MinVerPatch)-pr.$(APPVEYOR_PULL_REQUEST_NUMBER).build-id.$(APPVEYOR_BUILD_ID).$(MinVerPreRelease)</PackageVersion>
-    <PackageVersion Condition="'$(MinVerBuildMetadata)' != ''">$(PackageVersion)+$(MinVerBuildMetadata)</PackageVersion>
     <Version>$(PackageVersion)</Version>
   </PropertyGroup>
 </Target>