The build tool will now get the current version from the build config and automatically update the minor version by default, or the major or patch version if the argument is given; Improved the doxygen log output while building the docs; Smaller improvements

Author: basicx-StrgV

.nuke/build.schema.json

@@ -12,7 +12,7 @@
         },
         "DoxygenBin": {
           "type": "string",
-          "description": "The path of the doxygen bin directory (Default: C:\\Program Files\\doxygen\\bin)"
+          "description": "[Optional] The path of the doxygen bin directory (Default: C:\\Program Files\\doxygen\\bin)"
         },
         "Help": {
           "type": "boolean",
@@ -39,9 +39,13 @@
             "VSCode"
           ]
         },
+        "Major": {
+          "type": "boolean",
+          "description": "[Optional] Update the major version (Default: Minor version will be updated)"
+        },
         "NoDocs": {
           "type": "boolean",
-          "description": "Sets that no docs should be created"
+          "description": "[Optional] Sets that no docs should be created"
         },
         "NoLogo": {
           "type": "boolean",
@@ -51,6 +55,10 @@
           "type": "string",
           "description": "Partition to use on CI"
         },
+        "Patch": {
+          "type": "boolean",
+          "description": "[Optional] Update the patch version (Default: Minor version will be updated)"
+        },
         "Plan": {
           "type": "boolean",
           "description": "Shows the execution plan (HTML)"
@@ -75,6 +83,7 @@
               "Compile",
               "Docs",
               "Info",
+              "LoadConfig",
               "Pack",
               "Restore"
             ]
@@ -93,6 +102,7 @@
               "Compile",
               "Docs",
               "Info",
+              "LoadConfig",
               "Pack",
               "Restore"
             ]
@@ -110,7 +120,7 @@
         },
         "Version": {
           "type": "string",
-          "description": "Version of the package"
+          "description": "[Optional] Provide a new version for the package"
         }
       }
     }

src/build.config.json

@@ -0,0 +1,3 @@
+{
+  "currentVersion":  "3.2.0"
+}

src/build/Build.cs

@@ -1,3 +1,7 @@
+//--------------------------------------------------//
+// Created by basicx-StrgV                          //
+// https://github.com/basicx-StrgV/                 //
+//--------------------------------------------------//
 using System.IO;
 using Serilog;
 using Nuke.Common;
@@ -7,81 +11,207 @@
 
 namespace BuildTool
 {
-    class Build : NukeBuild
+    internal class Build : NukeBuild
     {
         public static int Main() => Execute<Build>(x => x.Pack);
 
-        [Parameter("Version of the package")]
-        public readonly string Version = "0.0.0";
+        [Parameter("[Optional] Update the major version (Default: Minor version will be updated)")]
+        public bool Major = false;
 
-        [Parameter("The path of the doxygen bin directory (Default: C:\\Program Files\\doxygen\\bin)")]
+        [Parameter("[Optional] Update the patch version (Default: Minor version will be updated)")]
+        public bool Patch = false;
+
+        [Parameter("[Optional] Provide a new version for the package")]
+        public readonly string? Version = null;
+
+        [Parameter("[Optional] The path of the doxygen bin directory (Default: C:\\Program Files\\doxygen\\bin)")]
         public readonly string DoxygenBin = "C:\\Program Files\\doxygen\\bin";
 
-        [Parameter("Sets that no docs should be created")]
+        [Parameter("[Optional] Sets that no docs should be created")]
         public readonly bool NoDocs = false;
 
         [Solution]
-        public readonly Solution Solution;
+        public readonly Solution? Solution;
 
         // Allways set config to release, because build is intended for creating ready to ship packages
         private readonly Configuration _configuration = Configuration.Release;
 
+        private string? _workingVersion = null;
+
         private static AbsolutePath _packages => RootDirectory / "nuget" / "packages";
         private static AbsolutePath _doxygenWorkingDir => RootDirectory / "doxygen";
         private static AbsolutePath _doxyfile => _doxygenWorkingDir / "Doxyfile";
+        private static AbsolutePath _srcDirectory => RootDirectory / "src";
+        private static AbsolutePath _configFile => _srcDirectory / "build.config.json";
+
+        Target LoadConfig => _ => _
+            .Unlisted()
+            .Before(Info, Restore, Compile, Pack)
+            .Executes(() =>
+            {
+                Log.Information("Loading the build config");
+
+                // Check if config exist
+                if (!File.Exists(_configFile))
+                {
+                    if (Version != null)
+                    {
+                        Log.Warning("Config file not found. The provided version ({version}) will still be used", Version);
+                        _workingVersion = Version;
+                    }
+                    else
+                    {
+                        Log.Warning("Config file not found. The version \"1.0.0\" will be used as a fallback");
+                        _workingVersion = "1.0.0";
+                    }
+
+                    // Proceed with next target
+                    return;
+                }
+
+                // Try to load data from config
+                ConfigHandler.BuildConfig? buildConfig = ConfigHandler.LoadConfig(_configFile);
+                if (buildConfig == null)
+                {
+                    if (Version != null)
+                    {
+                        Log.Warning("Failed to load the config file. The provided version ({version}) will still be used", Version);
+                        _workingVersion = Version;
+                    }
+                    else
+                    {
+                        Log.Warning("Failed to load the config file. The version \"1.0.0\" will be used as a fallback");
+                        _workingVersion = "1.0.0";
+                    }
+
+                    // Proceed with next target
+                    return;
+                }
+
+                // Try to parse the configured version
+                bool parsingResult = System.Version.TryParse(buildConfig.CurrentVersion, out System.Version? version);
+                if (version == null || !parsingResult)
+                {
+                    if (Version != null)
+                    {
+                        Log.Warning("The version provided by the config file ({configVersion}) is invalid. The provided version ({version}) will still be used", version, Version);
+                        _workingVersion = Version;
+                    }
+                    else
+                    {
+                        Log.Warning("The version provided by the config file ({configVersion}) is invalid. The version \"1.0.0\" will be used as a fallback", version);
+                        _workingVersion = "1.0.0";
+                    }
+
+                    // Proceed with next target
+                    return;
+                }
+
+                if (Major && Patch)
+                {
+                    // Cancel the build process
+                    Assert.Fail("Can't update major and patch at the same time");
+                }
+
+                if (Major || Patch)
+                {
+                    if (Major)
+                    {
+                        _workingVersion =
+                            new System.Version(version.Major + 1, 0, 0)
+                            .ToString();
+                    }
+                    else
+                    {
+                        _workingVersion =
+                            new System.Version(version.Major, version.Minor, version.Build + 1)
+                            .ToString();
+                    }
+
+                    return;
+                }
+
+                _workingVersion =
+                    new System.Version(version.Major, version.Minor + 1, version.Build)
+                    .ToString();
+            });
 
         Target Info => _ => _
             .Unlisted()
             .Before(Restore, Compile, Pack)
             .Executes(() =>
             {
                 Log.Information("Creating \"WGet.NET\" nuget package");
-                Log.Information("Version: {version}", Version);
+                Log.Information("Version: {version}", _workingVersion);
                 Log.Information("Output directory: {dir}", _packages);
             });
 
         Target Restore => _ => _
             .Unlisted()
             .Executes(() =>
             {
+                if (Solution == null)
+                {
+                    Assert.Fail("The solution was not loaded correctly");
+                    return; // Normaly not needed but the compiler does not know that.
+                }
+
                 DotNetTasks.DotNetRestore(s => s
                     .SetProjectFile(Solution.GetProject("WGet.NET")));
             });
 
         Target Compile => _ => _
-            .DependsOn(Restore)
+            .DependsOn(LoadConfig, Restore)
             .Executes(() =>
             {
+                if (Solution == null)
+                {
+                    Assert.Fail("The solution was not loaded correctly");
+                    return; // Normaly not needed but the compiler does not know that.
+                }
+
                 DotNetTasks.DotNetBuild(s => s
                     .SetProjectFile(Solution.GetProject("WGet.NET"))
                     .SetConfiguration(_configuration)
                     .EnableNoRestore()
-                    .SetVersion(Version)
-                    .SetFileVersion(Version)
-                    .SetAssemblyVersion(Version));
+                    .SetVersion(_workingVersion)
+                    .SetFileVersion(_workingVersion)
+                    .SetAssemblyVersion(_workingVersion));
             });
 
         Target Pack => _ => _
             .DependsOn(Info, Compile)
             .Triggers(Docs)
             .Executes(() =>
             {
+                if (Solution == null)
+                {
+                    Assert.Fail("The solution was not loaded correctly");
+                    return; // Normaly not needed but the compiler does not know that.
+                }
+
                 DotNetTasks.DotNetPack(s => s
                     .SetProject(Solution.GetProject("WGet.NET"))
                     .SetConfiguration(_configuration)
                     .SetNoBuild(true)
                     .SetOutputDirectory(_packages)
-                    .SetVersion(Version)
-                    .SetFileVersion(Version)
-                    .SetAssemblyVersion(Version)
-                    .SetProperty("PackageReleaseNotes", $"https://github.com/basicx-StrgV/WGet.NET/releases/tag/{Version}"));
+                    .SetVersion(_workingVersion)
+                    .SetFileVersion(_workingVersion)
+                    .SetAssemblyVersion(_workingVersion)
+                    .SetProperty("PackageReleaseNotes", $"https://github.com/basicx-StrgV/WGet.NET/releases/tag/{_workingVersion}"));
             });
 
         Target Docs => _ => _
         .Unlisted()
         .OnlyWhenDynamic(() => !NoDocs)
         .Executes(() =>
         {
+            if (_workingVersion == null)
+            {
+                Assert.Fail($"No version for the package is defined");
+                return; // Normaly not needed but the compiler does not know that.
+            }
+
             if (!Directory.Exists(DoxygenBin))
             {
                 Assert.Fail($"The doxygen bin directory does not exist ({DoxygenBin})");
@@ -106,7 +236,7 @@ class Build : NukeBuild
 
             DoxygenHandler doxygen = new(_doxyfile, doxygenExe, _doxygenWorkingDir);
 
-            bool result = doxygen.GenerateDocs(Version);
+            bool result = doxygen.GenerateDocs(_workingVersion);
 
             if (!result)
             {

src/build/ConfigHandler.cs

@@ -0,0 +1,33 @@
+//--------------------------------------------------//
+// Created by basicx-StrgV                          //
+// https://github.com/basicx-StrgV/                 //
+//--------------------------------------------------//
+using System.IO;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace BuildTool
+{
+    internal static class ConfigHandler
+    {
+        public class BuildConfig
+        {
+            [JsonPropertyName("currentVersion")]
+            public string? CurrentVersion { get; set; }
+        }
+
+        public static BuildConfig? LoadConfig(string configFile)
+        {
+            try
+            {
+                string configContent = File.ReadAllText(configFile);
+
+                return JsonSerializer.Deserialize<BuildConfig>(configContent);
+            }
+            catch
+            {
+                return null;
+            }
+        }
+    }
+}

src/build/DoxygenHandler.cs

@@ -1,11 +1,15 @@
-using Serilog;
+//--------------------------------------------------//
+// Created by basicx-StrgV                          //
+// https://github.com/basicx-StrgV/                 //
+//--------------------------------------------------//
+using Serilog;
 using System;
 using System.IO;
 using System.Diagnostics;
 
 namespace BuildTool
 {
-    public class DoxygenHandler
+    internal class DoxygenHandler
     {
         private readonly string _doxyfile;
         private readonly string _doxygen;
@@ -91,7 +95,17 @@ private int ExecuteDoxygen()
             using (StreamReader output = doxygenProc.StandardOutput)
             {
                 // Log the doxygen output
-                Log.Information(output.ReadLine());
+                while (!output.EndOfStream)
+                {
+                    string? line = output.ReadLine();
+
+                    if (line == null)
+                    {
+                        continue;
+                    }
+
+                    Log.Information(line);
+                }
             }
 
             // Wait for process exit with a timeout of 10 min

src/build/Properties/launchSettings.json

@@ -0,0 +1,8 @@
+{
+  "profiles": {
+    "_build": {
+      "commandName": "Project",
+      "commandLineArgs": "--no-docs"
+    }
+  }
+}

src/build/_build.csproj

@@ -9,6 +9,7 @@
     <NukeScriptDirectory>..</NukeScriptDirectory>
     <NukeTelemetryVersion>1</NukeTelemetryVersion>
     <IsPackable>false</IsPackable>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>