Update build script and other resource files. Upgrade to .NET SDK 6.0. Upgrade to Cake 2.0.0

Author: Jericho

.config/dotnet-tools.json

@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "cake.tool": {
-      "version": "1.2.0",
+      "version": "2.0.0",
       "commands": [
         "dotnet-cake"
       ]

.gitignore

@@ -5,7 +5,7 @@
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 ##
-## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
+## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
 
 # User-specific files
 *.rsuser
@@ -210,9 +210,6 @@ PublishScripts/
 *.nuget.props
 *.nuget.targets
 
-# Nuget personal access tokens and Credentials
-nuget.config
-
 # Microsoft Azure Build Output
 csx/
 *.build.csdef
@@ -301,6 +298,15 @@ node_modules/
 # Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
 *.vbw
 
+# Visual Studio 6 auto-generated project file (contains which files were open etc.)
+*.vbp
+
+# Visual Studio 6 workspace and project file (working project files containing files to include in project)
+*.dsw
+*.dsp
+
+# Visual Studio 6 technical files
+
 # Visual Studio LightSwitch build output
 **/*.HTMLClient/GeneratedArtifacts
 **/*.DesktopClient/GeneratedArtifacts
@@ -357,6 +363,9 @@ ASALocalRun/
 # Local History for Visual Studio
 .localhistory/
 
+# Visual Studio History (VSHistory) files
+.vshistory/
+
 # BeatPulse healthcheck temp database
 healthchecksdb
 
@@ -388,7 +397,6 @@ FodyWeavers.xsd
 *.msp
 
 # JetBrains Rider
-.idea/
 *.sln.iml
 
 ### VisualStudio Patch ###

GitReleaseManager.yaml

@@ -26,6 +26,7 @@ issue-labels-include:
   - Bug
   - New Feature
   - Improvement
+  - Enhancement
   - Documentation
   - Security
 issue-labels-exclude:

GitVersion.yml

@@ -13,11 +13,11 @@ branches:
   develop:
     regex: dev(elop)?(ment)?$
     mode: ContinuousDeployment
-    tag: alpha
+    tag: beta
   hotfix:
     regex: hotfix(es)?[/-]
     mode: ContinuousDeployment
-    tag: beta
+    tag: hotfix
   release:
     regex: release(s)?[/-]
     mode: ContinuousDeployment

appveyor.psm1

@@ -0,0 +1,62 @@
+# Inspired by: https://github.com/PowerShell/PSScriptAnalyzer/blob/master/tools/appveyor.psm1
+
+$ErrorActionPreference = 'Stop'
+
+# Implements the AppVeyor 'install' step and installs the desired .NET SDK if not already installed.
+function Invoke-AppVeyorInstall {
+
+    Write-Verbose -Verbose "Determining the desired version of .NET SDK"
+    $globalDotJson = Get-Content (Join-Path $PSScriptRoot 'global.json') -Raw | ConvertFrom-Json
+    $desiredDotNetCoreSDKVersion = $globalDotJson.sdk.version
+    Write-Verbose -Verbose "We have determined that the desired version of the .NET SDK is $desiredDotNetCoreSDKVersion"
+
+    Write-Verbose -Verbose "Checking availability of .NET SDK $desiredDotNetCoreSDKVersion"
+    $desiredDotNetCoreSDKVersionPresent = (dotnet --list-sdks) -match $desiredDotNetCoreSDKVersion
+
+    if (-not $desiredDotNetCoreSDKVersionPresent) {
+        Write-Verbose -Verbose "We have determined that the desired version of the .NET SDK is not present on this machine"
+        Write-Verbose -Verbose "Installing .NET SDK $desiredDotNetCoreSDKVersion"
+        $originalSecurityProtocol = [Net.ServicePointManager]::SecurityProtocol
+        try {
+            [Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12
+            if ($IsLinux -or $isMacOS) {
+                Invoke-WebRequest 'https://dot.net/v1/dotnet-install.sh' -OutFile dotnet-install.sh
+
+                # Normally we would execute dotnet-install.sh like so:
+                # bash dotnet-install.sh --version $desiredDotNetCoreSDKVersion
+                #
+                # and we would also update the PATH environment variable like so:
+                # $OLDPATH = [System.Environment]::GetEnvironmentVariable("PATH")
+                # $NEWPATH = "/home/appveyor/.dotnet$([System.IO.Path]::PathSeparator)$OLDPATH"
+                # [Environment]::SetEnvironmentVariable("PATH", "$NEWPATH")
+                #
+                # This is supposed to result in the desired .NET SDK to be installed side-by-side
+                # with the other version(s) of the SDK already installed. However, my experience
+                # on Ubuntu images in Appveyor has been that the recently installed SDK is the only
+                # one detected and the previous versions are no longer detected as being installed.
+                #
+                # This whole thing is problematic because GitVersion.Tool 5.7 is not compatible with
+                # .NET 6 (in fact, it doesn't even install) and you must have .NET 5 installed side-by-side
+                # with .NET 6 in order to install and use GitVersion.Tool
+                #
+                # I spent a whole day trying to find a solution but ultimately the only reliable solution
+                # I was able to come up with is to install in the default location (which is /usr/share/dotnet)
+                # using 'sudo' because you need admin privileges to access the default install location.
+
+                sudo bash dotnet-install.sh --version $desiredDotNetCoreSDKVersion --install-dir /usr/share/dotnet
+            }
+            else {
+                Invoke-WebRequest 'https://dot.net/v1/dotnet-install.ps1' -OutFile dotnet-install.ps1
+                .\dotnet-install.ps1 -Version $desiredDotNetCoreSDKVersion
+            }
+        }
+        finally {
+            [Net.ServicePointManager]::SecurityProtocol = $originalSecurityProtocol
+            Remove-Item .\dotnet-install.*
+        }
+        Write-Verbose -Verbose "Installed .NET SDK $desiredDotNetCoreSDKVersion"
+    }
+    else {
+        Write-Verbose -Verbose "We have determined that the desired version of the .NET SDK is already installed on this machine"
+    }
+}

appveyor.yml

@@ -1,12 +1,27 @@
-# Before Build
+# environment variables
+environment:
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true # For faster CI builds
+  DOTNET_ROLL_FORWARD: Major # See https://github.com/GitTools/GitVersion/issues/2906 until 5.8.0 is released
+
+# scripts that are called at very beginning, before repo cloning
 init:
   - git config --global core.autocrlf true
 
-# Build script
-build_script:
+# scripts that run after cloning repository
+install:
+ - ps: Import-Module .\appveyor.psm1; Invoke-AppveyorInstall
+
+# scripts to run before build
+before_build:
   - dotnet --info
+
+# to run your custom scripts instead of automatic MSBuild
+build_script:
   - ps: .\build.ps1 --target=AppVeyor
 
+# scripts to run after build
+after_build:
+
 # Tests
 test: off
 
@@ -26,11 +41,8 @@ cache:
 # Environment configuration
 image:
   - Ubuntu1804
-  - Visual Studio 2019
+  - Visual Studio 2022
 
-#---------------------------------#
-#  Skip builds for doc changes    #
-#---------------------------------#
+#  Skip builds for doc changes
 skip_commits:
-  # Regex for matching commit message
   message: /\(doc\).*/

build.cake

@@ -1,14 +1,14 @@
 // Install tools.
-#tool dotnet:?package=GitVersion.Tool&version=5.6.6
-#tool nuget:?package=GitReleaseManager&version=0.12.1
+#tool dotnet:?package=GitVersion.Tool&version=5.8.2
+#tool nuget:?package=GitReleaseManager&version=0.13.0
 #tool nuget:?package=OpenCover&version=4.7.1221
-#tool nuget:?package=ReportGenerator&version=4.8.12
+#tool nuget:?package=ReportGenerator&version=5.0.4
 #tool nuget:?package=coveralls.io&version=1.4.2
 #tool nuget:?package=xunit.runner.console&version=2.4.1
 
 // Install addins.
 #addin nuget:?package=Cake.Coveralls&version=1.1.0
-#addin nuget:?package=Cake.Git&version=1.1.0
+#addin nuget:?package=Cake.Git&version=2.0.0
 
 
 ///////////////////////////////////////////////////////////////////////////////
@@ -61,11 +61,10 @@ var isLocalBuild = BuildSystem.IsLocalBuild;
 var isMainBranch = StringComparer.OrdinalIgnoreCase.Equals("main", BuildSystem.AppVeyor.Environment.Repository.Branch);
 var isMainRepo = StringComparer.OrdinalIgnoreCase.Equals($"{gitHubRepoOwner}/{gitHubRepo}", BuildSystem.AppVeyor.Environment.Repository.Name);
 var isPullRequest = BuildSystem.AppVeyor.Environment.PullRequest.IsPullRequest;
-var isTagged = (
-	BuildSystem.AppVeyor.Environment.Repository.Tag.IsTag &&
-	!string.IsNullOrWhiteSpace(BuildSystem.AppVeyor.Environment.Repository.Tag.Name)
-);
-var isBenchmarkPresent = FileExists(benchmarkProject);
+var isTagged = BuildSystem.AppVeyor.Environment.Repository.Tag.IsTag && !string.IsNullOrWhiteSpace(BuildSystem.AppVeyor.Environment.Repository.Tag.Name);
+var isIntegrationTestsProjectPresent = FileExists(integrationTestsProject);
+var isUnitTestsProjectPresent = FileExists(unitTestsProject);
+var isBenchmarkProjectPresent = FileExists(benchmarkProject);
 
 // Generally speaking, we want to honor all the TFM configured in the source project and the unit test project.
 // However, there are a few scenarios where a single framework is sufficient. Here are a few examples that come to mind:
@@ -134,19 +133,29 @@ Setup(context =>
 	// Integration tests are intended to be used for debugging purposes and not intended to be executed in CI environment.
 	// Also, the runner for these tests contains windows-specific code (such as resizing window, moving window to center of screen, etc.)
 	// which can cause problems when attempting to run unit tests on an Ubuntu image on AppVeyor.
-	if (!isLocalBuild)
+	if (!isLocalBuild && isIntegrationTestsProjectPresent)
 	{
 		Information("");
 		Information("Removing integration tests");
-		DotNetCoreTool(solutionFile, "sln", $"remove {integrationTestsProject.TrimStart(sourceFolder, StringComparison.OrdinalIgnoreCase)}");
+		DotNetTool(solutionFile, "sln", $"remove {integrationTestsProject.TrimStart(sourceFolder, StringComparison.OrdinalIgnoreCase)}");
+	}
+
+	// Similarly, benchmarking can causes problems similar to this one:
+	// error NETSDK1005: Assets file '/home/appveyor/projects/stronggrid/Source/StrongGrid.Benchmark/obj/project.assets.json' doesn't have a target for 'net5.0'.
+	// Ensure that restore has run and that you have included 'net5.0' in the TargetFrameworks for your project.
+	if (!isLocalBuild && isBenchmarkProjectPresent)
+	{
+		Information("");
+		Information("Removing benchmark project");
+		DotNetTool(solutionFile, "sln", $"remove {benchmarkProject.TrimStart(sourceFolder, StringComparison.OrdinalIgnoreCase)}");
 	}
 });
 
 Teardown(context =>
 {
 	if (!isLocalBuild)
 	{
-		Information("Restoring integration tests");
+		Information("Restoring projects that may have been removed during build script setup");
 		GitCheckout(".", new FilePath[] { solutionFile });
 		Information("");
 	}
@@ -193,7 +202,7 @@ Task("Restore-NuGet-Packages")
 	.IsDependentOn("Clean")
 	.Does(() =>
 {
-	DotNetCoreRestore("./Source/", new DotNetCoreRestoreSettings
+	DotNetRestore("./Source/", new DotNetRestoreSettings
 	{
 		Sources = new [] {
 			"https://api.nuget.org/v3/index.json",
@@ -205,16 +214,18 @@ Task("Build")
 	.IsDependentOn("Restore-NuGet-Packages")
 	.Does(() =>
 {
-	DotNetCoreBuild(solutionFile, new DotNetCoreBuildSettings
+	DotNetBuild(solutionFile, new DotNetBuildSettings
 	{
 		Configuration = configuration,
 		Framework =  desiredFramework,
 		NoRestore = true,
-		ArgumentCustomization = args =>
+		MSBuildSettings = new DotNetMSBuildSettings
 		{
-			return args
-				.Append("/p:SemVer={0}", versionInfo.LegacySemVerPadded)
-				.Append("/p:ContinuousIntegrationBuild={0}", BuildSystem.IsLocalBuild ? "false" : "true");
+			Version = versionInfo.LegacySemVerPadded,
+			AssemblyVersion = versionInfo.MajorMinorPatch,
+			FileVersion = versionInfo.MajorMinorPatch,
+			InformationalVersion = versionInfo.InformationalVersion,
+			ContinuousIntegrationBuild = !BuildSystem.IsLocalBuild
 		}
 	});
 });
@@ -223,7 +234,7 @@ Task("Run-Unit-Tests")
 	.IsDependentOn("Build")
 	.Does(() =>
 {
-	DotNetCoreTest(unitTestsProject, new DotNetCoreTestSettings
+	DotNetTest(unitTestsProject, new DotNetTestSettings
 	{
 		NoBuild = true,
 		NoRestore = true,
@@ -236,7 +247,7 @@ Task("Run-Code-Coverage")
 	.IsDependentOn("Build")
 	.Does(() =>
 {
-	Action<ICakeContext> testAction = ctx => ctx.DotNetCoreTest(unitTestsProject, new DotNetCoreTestSettings
+	Action<ICakeContext> testAction = ctx => ctx.DotNetTest(unitTestsProject, new DotNetTestSettings
 	{
 		NoBuild = true,
 		NoRestore = true,
@@ -291,7 +302,7 @@ Task("Create-NuGet-Package")
 {
 	var releaseNotesUrl = @$"https://github.com/{gitHubRepoOwner}/{gitHubRepo}/releases/tag/{milestone}";
 
-	var settings = new DotNetCorePackSettings
+	var settings = new DotNetPackSettings
 	{
 		Configuration = configuration,
 		IncludeSource = false,
@@ -301,18 +312,14 @@ Task("Create-NuGet-Package")
 		NoDependencies = true,
 		OutputDirectory = outputDir,
 		SymbolPackageFormat = "snupkg",
-		ArgumentCustomization = (args) =>
+		MSBuildSettings = new DotNetMSBuildSettings
 		{
-			return args
-				.Append("/p:PackageReleaseNotes=\"{0}\"", releaseNotesUrl)
-				.Append("/p:Version={0}", versionInfo.LegacySemVerPadded)
-				.Append("/p:AssemblyVersion={0}", versionInfo.MajorMinorPatch)
-				.Append("/p:FileVersion={0}", versionInfo.MajorMinorPatch)
-				.Append("/p:AssemblyInformationalVersion={0}", versionInfo.InformationalVersion);
+			PackageReleaseNotes = releaseNotesUrl,
+			PackageVersion = versionInfo.LegacySemVerPadded
 		}
 	};
 
-	DotNetCorePack(sourceProject, settings);
+	DotNetPack(sourceProject, settings);
 });
 
 Task("Upload-AppVeyor-Artifacts")
@@ -408,14 +415,14 @@ Task("Publish-GitHub-Release")
 
 Task("Generate-Benchmark-Report")
 	.IsDependentOn("Build")
-	.WithCriteria(isBenchmarkPresent)
+	.WithCriteria(isBenchmarkProjectPresent)
 	.Does(() =>
 {
     var publishDirectory = $"{benchmarkDir}Publish/";
     var publishedAppLocation = MakeAbsolute(File($"{publishDirectory}{libraryName}.Benchmark.exe")).FullPath;
     var artifactsLocation = MakeAbsolute(File(benchmarkDir)).FullPath;
 
-    DotNetCorePublish(benchmarkProject, new DotNetCorePublishSettings
+    DotNetPublish(benchmarkProject, new DotNetPublishSettings
     {
         Configuration = configuration,
 		NoRestore = true,
@@ -452,7 +459,7 @@ Task("Coverage")
 
 Task("Benchmark")
 	.IsDependentOn("Generate-Benchmark-Report")
-	.WithCriteria(isBenchmarkPresent)
+	.WithCriteria(isBenchmarkProjectPresent)
 	.Does(() =>
 {
     var htmlReports = GetFiles($"{benchmarkDir}results/*-report.html", new GlobberSettings { IsCaseSensitive = false });

global.json

@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "5.0.400",
+    "version": "6.0.200",
     "rollForward": "latestFeature"
   }
 }