Switch build to Cake Frosting

Author: pascalberger

.azuredevops/pipelines/templates/stages/build-for-integration-tests.yml

@@ -12,7 +12,7 @@ stages:
         vmImage: 'ubuntu-22.04'
       steps:
       - template: ../steps/install-required-dotnet-versions-for-building.yml 
-      - bash: ./build.sh --target=Create-NuGet-Packages
+      - bash: ./build.sh --target=Package
         displayName: 'Build'
       - publish: $(Build.SourcesDirectory)/BuildArtifacts/Packages/NuGet
         artifact: NuGet Package

.config/dotnet-tools.json

@@ -32,7 +32,7 @@ jobs:
             8.x
             9.x
       - name: Build
-        run: ./build.sh --target=Create-NuGet-Packages
+        run: ./build.sh --target=Package
         shell: bash
       - name: Publish NuGet package as build artifact
         uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4

.github/workflows/integrationtests.yml

@@ -305,4 +305,5 @@ __pycache__/
 # Project specific 
 
 BuildArtifacts/
+build/tools/*
 docs/.cache/

.gitignore

@@ -1,15 +1,2 @@
-$ErrorActionPreference = 'Stop'
-
-$SCRIPT_NAME = "recipe.cake"
-
-Write-Host "Restoring .NET Core tools"
-dotnet tool restore
-if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
-
-Write-Host "Bootstrapping Cake"
-dotnet cake $SCRIPT_NAME --bootstrap
-if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
-
-Write-Host "Running Build"
-dotnet cake $SCRIPT_NAME @args
-if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
+dotnet run --project build/Build.csproj -- $args
+exit $LASTEXITCODE;

build.ps1

@@ -1,11 +1,2 @@
 #!/bin/bash
-SCRIPT_NAME="recipe.cake"
-
-echo "Restoring .NET Core tools"
-dotnet tool restore
-
-echo "Bootstrapping Cake"
-dotnet cake $SCRIPT_NAME --bootstrap
-
-echo "Running Build"
-dotnet cake $SCRIPT_NAME "$@"
+dotnet run --project ./build/Build.csproj -- "$@"

build.sh

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net9.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
+
+    <!-- Make sure start same folder .NET Core CLI and Visual Studio. -->
+    <!-- Also expected from Cake.Issues.Recipe to have build directory set as working directory. -->
+    <RunWorkingDirectory>$(MSBuildProjectDirectory)</RunWorkingDirectory>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Cake.Frosting" Version="5.0.0" />
+    <PackageReference Include="Cake.Frosting.Issues.Recipe" Version="5.1.1" />
+  </ItemGroup>
+
+</Project>

build/Build.csproj

@@ -0,0 +1,52 @@
+using Cake.Common;
+using Cake.Common.Build;
+using Cake.Common.Diagnostics;
+using Cake.Common.IO;
+using Cake.Common.Tools.GitVersion;
+using Cake.Core;
+using Cake.Frosting;
+using Spectre.Console;
+
+public class BuildLifetime : FrostingLifetime<BuildContext>
+{
+    public override void Setup(BuildContext context, ISetupContext info)
+    {
+        AnsiConsole.Write(new FigletText("Cake.Issues").Centered());
+
+        // Determine version
+        DetermineVersion(context);
+
+        // Cleanup "dist" folder
+        context.CleanDirectory(context.Parameters.OutputDirectory);
+    }
+
+    public override void Teardown(BuildContext context, ITeardownContext info)
+    {
+    }
+
+    private static void DetermineVersion(BuildContext context)
+    {
+        var settings = new GitVersionSettings
+        {
+            ToolPath = context.Tools.Resolve("dotnet-gitversion.exe")
+        };
+
+        if (settings.ToolPath == null)
+        {
+            settings.ToolPath = context.Tools.Resolve("dotnet-gitversion");
+        }
+
+        if (!context.BuildSystem().IsLocalBuild)
+        { 
+            settings.UpdateAssemblyInfo = true;
+            settings.UpdateAssemblyInfoFilePath =
+                context.State.RepositoryRootDirectory
+                    .GetRelativePath(context.Paths.SrcDirectoryPath)
+                    .CombineWithFilePath("SolutionInfo.cs");
+        }
+
+        context.State.Version = context.GitVersion(settings);
+
+        context.Information("Building version {0}", context.State.Version.FullSemVer);
+    }
+}

build/BuildLifetime.cs

@@ -0,0 +1,25 @@
+using Cake.Core;
+
+/// <summary>
+/// Class holding state during execution of build.
+/// </summary>
+public class BuildContext : IssuesContext<BuildParameters, BuildState>
+{
+    public Paths Paths { get; }
+
+    public BuildContext(ICakeContext context)
+        : base(context)
+    {
+        Paths = new Paths(this);
+    }
+
+    protected override BuildParameters CreateIssuesParameters()
+    {
+        return new BuildParameters(this);
+    }
+
+    protected override BuildState CreateIssuesState()
+    {
+        return new BuildState(this);
+    }
+}

build/Context/BuildContext.cs

@@ -0,0 +1,12 @@
+using Cake.Core;
+
+public class BuildParameters : IssuesParameters
+{
+    public MsBuildParameters MsBuild { get; }
+
+    public BuildParameters(ICakeContext context)
+    {
+        this.OutputDirectory = "../BuildArtifacts";
+        this.MsBuild = new MsBuildParameters(context);
+    }
+}