(build) Added ArgumentNullException checks for context.Version in various files.

Improved error messaging and updated some syntax for consistency and clarity

Author: arturcic

build/artifacts/Tasks/ArtifactsExecutableTest.cs

@@ -36,10 +36,10 @@ private static void PackageTest(BuildContextBase context, string packageToTest)
 
         context.NuGetInstall(packageToTest, new NuGetInstallSettings
         {
-            Source = new[]
-            {
+            Source =
+            [
                 context.MakeAbsolute(Paths.Nuget).FullPath
-            },
+            ],
             ExcludeVersion = true,
             Prerelease = true,
             OutputDirectory = outputDirectory

build/artifacts/Tasks/ArtifactsMsBuildFullTest.cs

@@ -36,7 +36,7 @@ public override void Run(BuildContext context)
                 Verbosity = DotNetVerbosity.Minimal,
                 Configuration = context.MsBuildConfiguration,
                 MSBuildSettings = dotnetMsBuildSettings,
-                Sources = new[] { nugetSource }
+                Sources = [nugetSource]
             });
 
             var exe = Paths.Integration.Combine("build").Combine(framework).CombineWithFilePath("app.dll");

build/build/BuildLifetime.cs

@@ -29,7 +29,8 @@ public override void Setup(BuildContext context, ISetupContext info)
     private static void SetMsBuildSettingsVersion(BuildContext context)
     {
         var msBuildSettings = context.MsBuildSettings;
-        var version = context.Version!;
+        ArgumentNullException.ThrowIfNull(context.Version);
+        var version = context.Version;
 
         msBuildSettings.SetVersion(version.SemVersion);
         msBuildSettings.SetAssemblyVersion(version.Version);

build/build/Tasks/Build.cs

@@ -16,7 +16,7 @@ public override void Run(BuildContext context)
         context.DotNetRestore(sln, new DotNetRestoreSettings
         {
             Verbosity = DotNetVerbosity.Minimal,
-            Sources = new[] { Constants.NugetOrgUrl },
+            Sources = [Constants.NugetOrgUrl],
             MSBuildSettings = context.MsBuildSettings
         });
 

build/build/Tasks/BuildPrepare.cs

@@ -16,7 +16,7 @@ public override void Run(BuildContext context)
             new()
             {
                 Verbosity = DotNetVerbosity.Minimal,
-                Sources = new[] { Constants.NugetOrgUrl },
+                Sources = [Constants.NugetOrgUrl],
             });
 
         context.DotNetBuild("./src/GitVersion.App/GitVersion.App.csproj",

build/build/Tasks/Package/PackageChocolatey.cs

@@ -35,10 +35,10 @@ public override void Run(BuildContext context)
             .Select(file => new ChocolateyNuSpecContent { Source = file.FullPath, Target = file.FullPath.Replace(artifactPath, "") })
             .ToArray();
 
-        metaPackageSettings.Dependencies = new[]
-        {
+        metaPackageSettings.Dependencies =
+        [
             new ChocolateyNuSpecDependency { Id = "GitVersion.Portable", Version = context.Version?.ChocolateyVersion }
-        };
+        ];
 
         context.ChocolateyPack(metaPackageSettings);
     }
@@ -51,17 +51,18 @@ private static ChocolateyPackSettings GetChocolateyPackSettings(BuildContextBase
             Version = context.Version?.ChocolateyVersion,
             Title = "GitVersion",
             Description = "Derives SemVer information from a repository following GitFlow or GitHubFlow.",
-            Authors = new[] { "GitTools and Contributors" },
-            Owners = new[] { "GitTools and Contributors" },
+            Authors = ["GitTools and Contributors"],
+            Owners = ["GitTools and Contributors"],
             Copyright = $"Copyright GitTools {DateTime.Now.Year}",
             DocsUrl = new Uri("https://gitversion.net/docs/"),
             LicenseUrl = new Uri("https://opensource.org/license/mit/"),
             ProjectUrl = new Uri("https://github.com/GitTools/GitVersion"),
             ProjectSourceUrl = new Uri("https://github.com/GitTools/GitVersion"),
             IconUrl = new Uri("https://raw.githubusercontent.com/GitTools/graphics/master/GitVersion/Color/icon_100x100.png"),
             RequireLicenseAcceptance = false,
-            Tags = new[] { "Git", "Versioning", "GitVersion", "GitFlowVersion", "GitFlow", "GitHubFlow", "SemVer" },
-            ReleaseNotes = new[] { $"https://github.com/GitTools/GitVersion/releases/tag/{context.Version?.ChocolateyVersion}" },
+            Tags = ["Git", "Versioning", "GitVersion", "GitFlowVersion", "GitFlow", "GitHubFlow", "SemVer"],
+            ReleaseNotes = [$"https://github.com/GitTools/GitVersion/releases/tag/{context.Version?.ChocolateyVersion}"
+            ],
             OutputDirectory = Paths.Nuget,
             LimitOutput = true,
         };

build/build/Tasks/Test/UnitTest.cs

@@ -73,7 +73,7 @@ private static void TestProjectForTarget(BuildContext context, FilePath project,
         };
 
         var resultsPath = context.MakeAbsolute(testResultsPath.CombineWithFilePath($"{projectName}.results.xml"));
-        settings.Loggers = new[] { $"junit;LogFilePath={resultsPath}" };
+        settings.Loggers = [$"junit;LogFilePath={resultsPath}"];
 
         var coverletSettings = new CoverletSettings
         {

build/build/Tasks/ValidateVersion.cs

@@ -9,7 +9,8 @@ public class ValidateVersion : FrostingTask<BuildContext>
 {
     public override void Run(BuildContext context)
     {
+        ArgumentNullException.ThrowIfNull(context.Version);
         var gitVersionTool = context.GetGitVersionToolLocation();
-        context.ValidateOutput("dotnet", $"\"{gitVersionTool}\" -version", context.Version!.GitVersion!.InformationalVersion!);
+        context.ValidateOutput("dotnet", $"\"{gitVersionTool}\" -version", context.Version.GitVersion.InformationalVersion);
     }
 }

build/common/Addins/GitVersion/GitVersionRunner.cs

@@ -6,7 +6,7 @@ namespace Common.Addins.GitVersion;
 /// <summary>
 /// The GitVersion runner.
 /// </summary>
-public sealed class GitVersionRunner : Tool<GitVersionSettings>
+public sealed partial class GitVersionRunner : Tool<GitVersionSettings>
 {
     private readonly ICakeLog _log;
 
@@ -38,14 +38,13 @@ public GitVersion Run(GitVersionSettings settings)
         Run(settings, GetArguments(settings), new ProcessSettings { RedirectStandardOutput = true }, process =>
         {
             output = string.Join("\n", process.GetStandardOutput());
-            if (this._log.Verbosity < Verbosity.Diagnostic)
+            if (this._log.Verbosity >= Verbosity.Diagnostic) return;
+            var regex = ParseErrorRegex();
+            var errors = regex.Matches(output)
+                .SelectMany(match => new[] { match.Groups[1].Value, match.Groups[2].Value });
+            foreach (var error in errors)
             {
-                var errors = Regex.Matches(output, @"( *ERROR:? [^\n]*)\n([^\n]*)")
-                    .SelectMany(match => new[] { match.Groups[1].Value, match.Groups[2].Value });
-                foreach (var error in errors)
-                {
-                    this._log.Error(error);
-                }
+                this._log.Error(error);
             }
         });
 
@@ -68,6 +67,7 @@ private ProcessArgumentBuilder GetArguments(GitVersionSettings settings)
             builder.Append("-output");
             builder.Append("json");
         }
+
         if (settings.OutputTypes.Contains(GitVersionOutput.BuildServer))
         {
             builder.Append("-output");
@@ -116,7 +116,8 @@ private ProcessArgumentBuilder GetArguments(GitVersionSettings settings)
             }
             else
             {
-                this._log.Warning("If you leave the branch name for GitVersion unset, it will fallback to the default branch for the repository.");
+                this._log.Warning(
+                    "If you leave the branch name for GitVersion unset, it will fallback to the default branch for the repository.");
             }
 
             if (!string.IsNullOrWhiteSpace(settings.Commit))
@@ -150,6 +151,7 @@ private ProcessArgumentBuilder GetArguments(GitVersionSettings settings)
             builder.Append("-verbosity");
             builder.Append(verbosity.ToString());
         }
+
         return builder;
     }
 
@@ -163,5 +165,14 @@ private ProcessArgumentBuilder GetArguments(GitVersionSettings settings)
     /// Gets the possible names of the tool executable.
     /// </summary>
     /// <returns>The tool executable name.</returns>
-    protected override IEnumerable<string> GetToolExecutableNames() => new[] { "GitVersion.exe", "dotnet-gitversion", "dotnet-gitversion.exe", "gitversion" };
+    protected override IEnumerable<string> GetToolExecutableNames() =>
+    [
+        "GitVersion.exe",
+        "dotnet-gitversion",
+        "dotnet-gitversion.exe",
+        "gitversion"
+    ];
+
+    [GeneratedRegex(@"( *ERROR:? [^\n]*)\n([^\n]*)")]
+    private static partial Regex ParseErrorRegex();
 }

build/common/Lifetime/BuildLifetimeBase.cs

@@ -30,11 +30,18 @@ public override void Setup(T context, ISetupContext info)
             context.Information("Running BuildPrepare...");
             return;
         }
+
+        var gitVersionPath = context.GetGitVersionDotnetToolLocation();
+        if (gitVersionPath is null || context.FileExists(gitVersionPath) is false)
+        {
+            throw new FileNotFoundException("Failed to locate the Release build of gitversion.dll in ./tools/gitversion. Try running \"./build.ps1 -Stage build -Target BuildPrepare\"");
+        }
+
         var gitVersionSettings = new GitVersionSettings
         {
             OutputTypes = [GitVersionOutput.Json, GitVersionOutput.BuildServer],
             ToolPath = context.Tools.Resolve(["dotnet.exe", "dotnet"]),
-            ArgumentCustomization = args => args.Prepend(context.GetGitVersionDotnetToolLocation()?.FullPath ?? throw new FileNotFoundException("Failed to locate the Release build of gitversion.dll in ./tools/gitversion. Try running \"./build.ps1 -Stage build -Target BuildPrepare\""))
+            ArgumentCustomization = args => args.Prepend(gitVersionPath.FullPath)
         };
 
         var gitVersion = context.GitVersion(gitVersionSettings);