Use MinVer for versioning

- Switch to MinVer from GitVersion to make tag-based versioning simpler and reduce the build complexity. - Fix incorrect condition for publishing to GitHub Packages for tags. - Refactor the build script to reduce repetition. - README tidy-up.
App-vNext · Jun 13, 2023 · 53e01a8 · 53e01a8
1 parent bde632e
commit 53e01a8
Show file tree

Hide file tree

Showing 9 changed files with 126 additions and 205 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -7,12 +7,6 @@
       "commands": [
         "dotnet-cake"
       ]
-    },
-    "GitVersion.Tool": {
-      "version": "5.12.0",
-      "commands": [
-        "dotnet-gitversion"
-      ]
     }
   }
 }
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -124,7 +124,7 @@ jobs:
     if: |
       github.event.repository.fork == false &&
       (github.ref == format('refs/heads/{0}', github.event.repository.default_branch) ||
-       startsWith(github.ref, 'refs/tags/v'))
+       startsWith(github.ref, 'refs/tags/'))
     steps:
 
     - name: Download packages

diff --git a/GitVersion.yml b/GitVersion.yml
diff --git a/README.md b/README.md
diff --git a/Version.props b/Version.props
diff --git a/build.cake b/build.cake
@@ -17,9 +17,7 @@ var configuration = Argument<string>("configuration", "Release");
 //////////////////////////////////////////////////////////////////////
 
 #addin nuget:?package=Cake.FileHelpers&version=6.0.0
-#addin nuget:?package=Cake.Yaml&version=6.0.0
 #addin nuget:?package=Newtonsoft.Json&version=13.0.2
-#addin nuget:?package=YamlDotNet&version=12.3.1
 
 ///////////////////////////////////////////////////////////////////////////////
 // GLOBAL VARIABLES
@@ -37,28 +35,10 @@ var testResultsDir = System.IO.Path.Combine(artifactsDir, Directory("test-result
 // NuGet
 var nupkgDestDir = System.IO.Path.Combine(artifactsDir, Directory("nuget-packages"));
 
-// GitVersion
-var gitVersionPath = ToolsExePath("GitVersion.exe");
-var gitVersionConfigFilePath = "./GitVersion.yml";
-Dictionary<string, object> gitVersionOutput;
-
-// Versioning
-string nugetVersion;
-string assemblyVersion;
-string assemblyFileVersion;
-
 // Stryker / Mutation Testing
 var strykerConfig = File("./eng/stryker-config.json");
 var strykerOutput = Directory("StrykerOutput");
 
-///////////////////////////////////////////////////////////////////////////////
-// INNER CLASSES
-///////////////////////////////////////////////////////////////////////////////
-class GitVersionConfigYaml
-{
-    public string NextVersion { get; set; }
-}
-
 ///////////////////////////////////////////////////////////////////////////////
 // SETUP / TEARDOWN
 ///////////////////////////////////////////////////////////////////////////////
@@ -120,57 +100,6 @@ Task("__RestoreNuGetPackages")
     }
 });
 
-Task("__UpdateAssemblyVersionInformation")
-    .Does(() =>
-{
-    var gitVersionSettings = new ProcessSettings()
-        .SetRedirectStandardOutput(true)
-        .WithArguments(args => args.Append("gitversion"));
-
-    try
-    {
-        IEnumerable<string> outputLines;
-        StartProcess("dotnet", gitVersionSettings, out outputLines);
-
-        var output = string.Join("\n", outputLines);
-        gitVersionOutput = Newtonsoft.Json.JsonConvert.DeserializeObject<Dictionary<string, object>>(output);
-    }
-    catch
-    {
-        Information("Error reading git version information. Build may be running outside of a git repo. Falling back to version specified in " + gitVersionConfigFilePath);
-
-        string gitVersionYamlString = System.IO.File.ReadAllText(gitVersionConfigFilePath);
-        GitVersionConfigYaml deserialized = DeserializeYaml<GitVersionConfigYaml>(gitVersionYamlString.Replace("next-version", "NextVersion"));
-        string gitVersionConfig = deserialized.NextVersion;
-
-        gitVersionOutput = new Dictionary<string, object>
-        {
-            { "NuGetVersion", gitVersionConfig + "-NotFromGitRepo" },
-            { "FullSemVer", gitVersionConfig },
-            { "AssemblySemVer", gitVersionConfig },
-            { "Major", gitVersionConfig.Split('.')[0] },
-        };
-    }
-
-    Information("");
-    Information("Obtained raw version info for package versioning:");
-    Information("NuGetVersion -> {0}", gitVersionOutput["NuGetVersion"]);
-    Information("FullSemVer -> {0}", gitVersionOutput["FullSemVer"]);
-    Information("AssemblySemVer -> {0}", gitVersionOutput["AssemblySemVer"]);
-    Information("MajorMinorPatch -> {0}", gitVersionOutput["MajorMinorPatch"]);
-    Information("CommitsSinceVersionSource -> {0}", gitVersionOutput["CommitsSinceVersionSource"]);
-
-    nugetVersion = gitVersionOutput["NuGetVersion"].ToString();
-    assemblyVersion = gitVersionOutput["Major"].ToString() + ".0.0.0";
-    assemblyFileVersion = gitVersionOutput["MajorMinorPatch"].ToString() + "." + gitVersionOutput["CommitsSinceVersionSource"].ToString();
-
-    Information("");
-    Information("Mapping versioning information to:");
-    Information("NuGet package version -> {0}", nugetVersion);
-    Information("AssemblyVersion -> {0}", assemblyVersion);
-    Information("AssemblyFileVersion -> {0}", assemblyFileVersion);
-});
-
 Task("__BuildSolutions")
     .Does(() =>
 {
@@ -185,10 +114,7 @@ Task("__BuildSolutions")
             NoRestore = true,
             MSBuildSettings = new DotNetMSBuildSettings
             {
-                AssemblyVersion = assemblyVersion,
-                FileVersion = assemblyFileVersion,
                 TreatAllWarningsAs = MSBuildTreatAllWarningsAs.Error,
-                Version = nugetVersion,
             },
         };
 
@@ -278,25 +204,24 @@ Task("__CreateNuGetPackages")
         OutputDirectory = nupkgDestDir,
         MSBuildSettings = new DotNetMSBuildSettings
         {
-            AssemblyVersion = assemblyVersion,
-            FileVersion = assemblyFileVersion,
             TreatAllWarningsAs = MSBuildTreatAllWarningsAs.Error,
-            PackageVersion = nugetVersion,
-            Version = nugetVersion,
         },
     };
 
-    Information("Building Polly.Core.{0}.nupkg", nugetVersion);
-    DotNetPack(System.IO.Path.Combine(srcDir, "Polly.Core", "Polly.Core.csproj"), dotNetPackSettings);
-
-    Information("Building Polly.{0}.nupkg", nugetVersion);
-    DotNetPack(System.IO.Path.Combine(srcDir, "Polly", "Polly.csproj"), dotNetPackSettings);
+    var packages = new[]
+    {
+        System.IO.Path.Combine(srcDir, "Polly.Core", "Polly.Core.csproj"),
+        System.IO.Path.Combine(srcDir, "Polly", "Polly.csproj"),
+        System.IO.Path.Combine(srcDir, "Polly.RateLimiting", "Polly.RateLimiting.csproj"),
+        System.IO.Path.Combine(srcDir, "Polly.Extensions", "Polly.Extensions.csproj"),
+    };
 
-    Information("Building Polly.RateLimiting.{0}.nupkg", nugetVersion);
-    DotNetPack(System.IO.Path.Combine(srcDir, "Polly.RateLimiting", "Polly.RateLimiting.csproj"), dotNetPackSettings);
+    Information("Building NuGet packages");
 
-    Information("Building Polly.Extensions.{0}.nupkg", nugetVersion);
-    DotNetPack(System.IO.Path.Combine(srcDir, "Polly.Extensions", "Polly.Extensions.csproj"), dotNetPackSettings);
+    foreach (string project in packages)
+    {
+        DotNetPack(project, dotNetPackSettings);
+    }
 });
 
 //////////////////////////////////////////////////////////////////////
@@ -306,7 +231,6 @@ Task("__CreateNuGetPackages")
 Task("Build")
     .IsDependentOn("__Clean")
     .IsDependentOn("__RestoreNuGetPackages")
-    .IsDependentOn("__UpdateAssemblyVersionInformation")
     .IsDependentOn("__BuildSolutions")
     .IsDependentOn("__RunTests")
     .IsDependentOn("__RunMutationTests")

diff --git a/eng/Benchmark.targets b/eng/Benchmark.targets
@@ -1,7 +1,5 @@
 <Project>
 
-  <Import Project="..\Version.props" />
-
   <ItemGroup>
     <PackageReference Include="BenchmarkDotNet" />
   </ItemGroup>

diff --git a/eng/Library.targets b/eng/Library.targets
@@ -1,5 +1,4 @@
 <Project>
-  <Import Project="..\Version.props" />
 
   <PropertyGroup>
     <Company>App vNext</Company>
@@ -59,4 +58,21 @@
       <InternalsVisibleTo Include="%(InternalsVisibleToTest.Identity)$(PollyPublicKeySuffix)" />
     </ItemGroup>
   </Target>
+
+  <ItemGroup Label="MinVer">
+    <PackageReference Include="MinVer" PrivateAssets="All" />
+  </ItemGroup>
+
+  <PropertyGroup Label="MinVer">
+    <MinVerMinimumMajorMinor>8.0</MinVerMinimumMajorMinor>
+  </PropertyGroup>
+
+  <Target Name="CustomizeVersions" AfterTargets="MinVer" Condition="'$(GITHUB_ACTIONS)' == 'true'">
+    <PropertyGroup>
+      <FileVersion>$(MinVerMajor).$(MinVerMinor).$(MinVerPatch).$(GITHUB_RUN_NUMBER)</FileVersion>
+    </PropertyGroup>
+    <PropertyGroup Condition="$(GITHUB_REF.StartsWith(`refs/pull/`))">
+      <PackageVersion>$(MinVerMajor).$(MinVerMinor).$(MinVerPatch)-pr.$(GITHUB_REF_NAME.Replace(`/merge`, ``)).$(GITHUB_RUN_NUMBER)</PackageVersion>
+    </PropertyGroup>
+  </Target>
 </Project>
diff --git a/src/Directory.Packages.props b/src/Directory.Packages.props
@@ -13,6 +13,7 @@
     <PackageVersion Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="7.0.0" />
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.6.2" />
     <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="1.1.1" />
+    <PackageVersion Include="MinVer" Version="4.3.0" />
     <PackageVersion Include="Moq" Version="4.18.4" />
     <PackageVersion Include="Polly.Contrib.WaitAndRetry" Version="1.1.1" />
     <PackageVersion Include="ReportGenerator" Version="5.1.22" />
@@ -38,4 +39,4 @@
     <PackageVersion Include="Microsoft.Extensions.Options" Version="2.2.0" />
     <PackageVersion Include="Microsoft.Extensions.Logging.Abstractions" Version="2.2.0" />
   </ItemGroup>
-</Project>
+</Project>