Enhance build process by adding packing functionality and updating Cake.Tool installation steps

Author: epidemicz

.github/workflows/main.yml

@@ -30,7 +30,9 @@ jobs:
           dotnet-version: "8.0.x"
 
       - name: Install Cake.Tool
-        run: dotnet tool install --global Cake.Tool && dotnet tool restore
+        run: |
+          dotnet tool install --global Cake.Tool
+          dotnet tool restore
 
       - name: Run Cake build
         run: dotnet cake --target=Build

.gitignore

@@ -362,3 +362,4 @@ MigrationBackup/
 # Fody - auto-generated XML schema
 FodyWeavers.xsd
 .vscode/settings.json
+tools/Addins/*

build.cake

@@ -1,19 +1,76 @@
-var target = Argument("target", "Build");
+var target = Argument("target", "Pack");
 var configuration = Argument("configuration", "Release");
 
+var assemblyName = "FreeGameNotifications";
+var solution = "./source/FreeGameNotifications.sln";
+var output = $"./source/bin/{configuration}";
+
+// List of files to pack, everything else is ignored
+List<string> filesToPack = [
+    "extension.yaml",
+    $"{assemblyName}.dll",
+    $"{assemblyName}.pdb",
+    "icon.png",
+    "en_US.xaml"
+];
+
+private (string id, string version) ReadExtensionManifest()
+{
+    var manifestPath = $"{output}/extension.yaml";
+    var manifestLines = System.IO.File.ReadAllLines(manifestPath);
+
+    var id = manifestLines
+        .FirstOrDefault(line => line.StartsWith("Id:"))
+        ?.Replace("Id: ", string.Empty);
+
+    var version = manifestLines
+        .FirstOrDefault(line => line.StartsWith("Version:"))
+        ?.Replace("Version: ", string.Empty)
+        ?.Replace(".", "_");
+
+    Information("Reading extension.yaml: Id: {0}, Version: {1}", id, version);
+
+    return (id, version);
+}
+
+string PackExtension()
+{
+    // remove all files from output folder except the ones in filesToPack
+    var files = System.IO.Directory.GetFiles(output, "*.*", System.IO.SearchOption.AllDirectories);
+
+    Information("Preparing to pack files");
+    foreach (var file in files)
+    {
+        var name = System.IO.Path.GetFileName(file);
+        if (!filesToPack.Contains(name))
+        {
+            Information("File not in filesToPack, removing: {0}", name);
+            System.IO.File.Delete(file);
+        }
+    }
+
+    // Read extension manifest
+    (var id, var version) = ReadExtensionManifest();
+    var packedExtension = $"{output}/{id}_{version}.pext";
+
+    // Zip contents of output
+    Zip(output, packedExtension);
+
+    return packedExtension;
+}
+
 Task("Clean")
-    .WithCriteria(c => HasArgument("rebuild"))
     .Does(() =>
     {
-        CleanDirectory($"./source/bin/{configuration}");
+        CleanDirectory(output);
     });
 
 Task("Restore")
     .Does(() =>
     {
         // Restore NuGet packages
         Information("Restoring NuGet packages...");
-        DotNetRestore("./source/FreeGameNotifications.sln");
+        NuGetRestore(solution);
     });
 
 Task("Build")
@@ -22,22 +79,22 @@ Task("Build")
     .Does(() =>
     {
         // Build the solution
-        MSBuild("./source/FreeGameNotifications.sln", settings =>
+        MSBuild(solution, settings =>
         {
             settings.SetConfiguration(configuration);
         });
     });
 
-// Task("Pack")
-//     .IsDependentOn("Build")
-//     .Does(() =>
-//     {
-//         // Run toolbox.exe with parameters
-//         var outputDir = $"./source/bin/{configuration}";
-//         StartProcess("tools/toolbox.exe", new ProcessSettings
-//         {
-//             Arguments = $"pack {outputDir} {outputDir}"
-//         });
-//     });
+Task("Pack")
+    .IsDependentOn("Build")
+    .Does(async () =>
+    {
+        var packedExtension = PackExtension();
+
+        // upload packedExtension artifact to github
+        Information("Packed extension: {0}", packedExtension);
+
+        await GitHubActions.Commands.UploadArtifact(new FilePath(packedExtension), packedExtension);
+    });
 
 RunTarget(target);