Merge branch 'develop' into copilot/fix-376

Author: pascalberger

.github/copilot-instructions.md

@@ -1,36 +1,137 @@
-This is a .NET based repository containing recipes for the Cake Build Automation System bundling individual Cake Issues addins.
-The individual recipes are published as NuGet packages.
+# Cake.Issues.Recipe
 
-See https://cakeissues.net/ for documentation and more information about Cake Issues.
+Cake.Issues.Recipe is a .NET repository containing recipes for the Cake Build Automation System bundling individual Cake Issues addins. The individual recipes are published as NuGet packages. The repository provides recipes for both Cake Scripting and Cake Frosting.
 
-Follow these guidelines when contributing:
+Always reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does not match the info here.
 
-## Before committing code
-- Ensure no warning or error messages from Roslyn analyzers are present in the code.
-- Ensure Unit Tests are passing.
-- Ensure Integration Tests are passing.
+## Working Effectively
 
-## Development Flow
-- Only building: `build.sh --target=DotNetCore-Build`
-- Publish NuGet Packages: `build.sh --target=Create-NuGet-Packages`
-- Run Unit Tests: `build.sh --target=Test`
-- Run Integration Tests:
-  - Run first `build.sh --target=Create-NuGet-Packages` in the root directory to create the NuGet packages.
-  - Run `build.sh` in the `tests/<RECIPE-NAME>/<TEST>` directory to run the integration tests for the corresponding recipe
-- Full CI check: `build.sh` (includes build, publish, test)
+### Prerequisites
+- Install .NET 8 and .NET 9 SDKs
+- For integration tests: Install `markdownlint-cli` globally: `npm install -g markdownlint-cli`
 
-To have verbose output of build.sh the following parameter can be add `--verbosity=diagnostic`
+### Bootstrap, build, and test the repository
+- Make build script executable: `chmod +x build.sh`
+- Full build and test: `./build.sh` -- takes 40 seconds. NEVER CANCEL. Set timeout to 120+ seconds.
+- Build only: `./build.sh --target=DotNetCore-Build` -- takes 2.5 minutes. NEVER CANCEL. Set timeout to 300+ seconds.
+- Run unit tests: `./build.sh --target=Test` -- takes 30 seconds. NEVER CANCEL. Set timeout to 120+ seconds.
+- Create NuGet packages: `./build.sh --target=Create-NuGet-Packages` -- takes 30 seconds. NEVER CANCEL. Set timeout to 120+ seconds.
+
+### Check available build targets
+- View all targets: `./build.sh --tree`
+- Get help: `./build.sh --help`
+- Verbose output: `./build.sh --verbosity=diagnostic`
+
+### Run integration tests
+- ALWAYS run `./build.sh --target=Create-NuGet-Packages` first in the root directory to create NuGet packages
+- Run specific integration test:
+  - `cd tests/script-runner/net8.0-git-cli/`
+  - `chmod +x build.sh && ./build.sh` -- takes 20 seconds. NEVER CANCEL. Set timeout to 120+ seconds.
+- Integration tests validate the recipes work correctly with sample projects
+
+## Validation
+
+### Build validation steps
+- ALWAYS run the full build after making changes: `./build.sh`
+- Run unit tests: `./build.sh --target=Test`
+- For recipe changes, ALWAYS run integration tests to ensure recipes work correctly
+- Check build artifacts in `BuildArtifacts/Packages/NuGet/` after package creation
+
+### Code quality requirements
+- Ensure no warning or error messages from Roslyn analyzers are present
+- Unit tests must pass
+- Integration tests must pass
+- Build artifacts must be created successfully
 
 ## Repository Structure
-- `Cake.Frosting.Issues.Recipe`: Contains the source code for the recipe for use with Cake Frosting
-- `Cake.Issues.Recipe`: Contains the source code for the recipe for use with Cake Scripting
-- `nuspec/nuget`: Contains the NuGet specification files for the Cake Scripting addin
-- `tests`: Contains integration tests for the recipes
-- `.github/workflows`: Contains GitHub Actions workflows for CI/CD which need to be maintained
-- `.azuredevops/pipelines/templates`: Contains Azure Pipelines templates which need to be maintained. The main file is `azure-pipelines.yml` in the root directory.
-
-## Key Guidelines
+
+### Key projects
+- `Cake.Issues.Recipe/`: Contains the source code for the recipe for use with Cake Scripting
+- `Cake.Frosting.Issues.Recipe/`: Contains the source code for the recipe for use with Cake Frosting
+  - `Cake.Frosting.Issues.Recipe.csproj`: Main Frosting recipe project
+  - `Cake.Frosting.Issues.Recipe.Tests.csproj`: Unit tests for Frosting recipe
+- `nuspec/nuget/`: Contains NuGet specification files for the Cake Scripting addin
+- `tests/`: Contains integration tests for both recipes
+  - `script-runner/`: Integration tests for Cake Scripting recipe
+  - `frosting/`: Integration tests for Cake Frosting recipe
+- `.github/workflows/`: GitHub Actions workflows for CI/CD
+- `.azuredevops/pipelines/`: Azure Pipelines templates
+- `azure-pipelines.yml`: Main Azure DevOps pipeline configuration
+
+### Build system
+- Uses Cake.Recipe (meta-build system for Cake addins)
+- Main build configuration: `recipe.cake`
+- Build scripts: `build.sh` (Linux/macOS), `build.ps1` (Windows)
+- Uses GitVersion for semantic versioning
+
+### Common commands reference
+
+#### Repository root contents
+```
+.appveyor.yml
+.azuredevops/
+.config/
+.github/
+.gitignore
+.vscode/
+CONTRIBUTING.md
+Cake.Frosting.Issues.Recipe/
+Cake.Issues.Recipe/
+GitReleaseManager.yaml
+LICENSE
+README.md
+azure-pipelines.yml
+build.ps1
+build.sh
+nuspec/
+recipe.cake
+tests/
+```
+
+#### Available build targets (most commonly used)
+- `Build`: Build all projects
+- `Test`: Run unit tests
+- `Package`: Create NuGet packages and run full validation
+- `Create-NuGet-Packages`: Create NuGet packages only
+- `DotNetCore-Build`: Build without tests or packaging
+- `DotNetCore-Restore`: Restore NuGet packages only
+
+#### Integration test structure
+- Each test has variants for .NET 8/9 and different repository providers (git-cli, cake-git)
+- Tests contain sample projects that demonstrate recipe functionality
+- Tests validate issues are detected and reported correctly
+
+## Development Guidelines
+
+### Key principles
 1. Maintain existing code structure and organization
-2. Write unit tests for new functionality.
-3. Write integration tests for new functionality which can't be tested with unit tests.
-4. Ensure Cake.Issues.Recipe and Cake.Frosting.Issues.Recipe are kept in sync regarding the features they provide.
+2. Write unit tests for new functionality
+3. Write integration tests for functionality that can't be tested with unit tests
+4. Ensure Cake.Issues.Recipe and Cake.Frosting.Issues.Recipe are kept in sync regarding features
+
+### Making changes
+- ALWAYS test both unit tests and integration tests after changes
+- Both Cake Scripting and Cake Frosting recipes should provide equivalent functionality
+- Recipe changes often require updates to both variants
+- Integration tests must pass to ensure recipes work in real scenarios
+
+### CI/CD compatibility
+- The build runs on Windows, macOS, and Ubuntu across multiple .NET versions
+- GitHub Actions and Azure DevOps are both used for CI
+- AppVeyor is also used for some builds
+
+### Common tasks timing reference
+- Tool restoration: ~5 seconds
+- .NET restore: ~30 seconds  
+- Build (first time): ~2.5 minutes
+- Build (incremental): ~10 seconds
+- Unit tests: ~30 seconds
+- NuGet package creation: ~30 seconds
+- Integration test: ~20 seconds per test
+- Full build: ~40 seconds
+
+### Troubleshooting
+- If markdownlint fails in integration tests: Install `markdownlint-cli` with `npm install -g markdownlint-cli`
+- Build warnings about deprecated packages are expected and can be ignored
+- Some assembly load warnings during build are expected and can be ignored
+- Integration tests create sample code with intentional issues for validation

.github/workflows/build.yml

@@ -7,11 +7,11 @@ jobs:
     runs-on: windows-2025
     steps:
       - name: Get the sources
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       - name: Fetch all tags and branches
         run: git fetch --prune --unshallow
       - name: Install .NET
-        uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4
+        uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4.3.1
         with:
           # .NET 5 required for GitVersion
           dotnet-version: |
@@ -22,7 +22,7 @@ jobs:
         run: .\build.ps1
         shell: powershell
       - name: Publish NuGet package as build artifact
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: NuGet Package
           path: ./BuildArtifacts/Packages/NuGet/
@@ -33,17 +33,17 @@ jobs:
     runs-on: windows-2025
     steps:
       - name: Get the sources
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       - name: Install required tools
         run: npm install -g markdownlint-cli
         shell: powershell
       - name: Download build artifact
-        uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5
+        uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
         with:
           name: NuGet Package
           path: ./BuildArtifacts/Packages/NuGet
       - name: Install .NET
-        uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4
+        uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4.3.1
         with:
           dotnet-version: |
             8.x
@@ -52,7 +52,7 @@ jobs:
         working-directory: ./tests/script-runner/net8.0-git-cli/
         shell: powershell
       - name: Publish generated reports as build artifact
-        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: Integration Tests Script Runner Windows (.NET tool)
           path: ./tests/script-runner/net8.0/BuildArtifacts/output/

.github/workflows/copilot-setup-steps.yml

@@ -24,11 +24,11 @@ jobs:
     # Defined steps will run before the agent starts.
     steps:
       - name: Checkout code
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       - name: Fetch all tags and branches
         run: git fetch --prune --unshallow
       - name: Install .NET
-        uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4
+        uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4.3.1
         with:
           # .NET 5 required for GitVersion
           dotnet-version: | 

Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe.Tests/Cake.Frosting.Issues.Recipe.Tests.csproj

@@ -18,16 +18,17 @@
 
   <ItemGroup>
     <PackageReference Include="Cake.Frosting" Version="5.0.0" />
-    <PackageReference Include="Cake.Issues.Testing" Version="5.7.0" />
+    <PackageReference Include="Cake.Issues.Testing" Version="5.8.0" />
     <PackageReference Include="Cake.Testing" Version="5.0.0" />
     <PackageReference Include="Cake.Testing.Xunit" Version="5.0.0" />
     <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="9.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
+    <PackageReference Include="NSubstitute" Version="5.3.0" />
     <PackageReference Include="xunit" Version="2.9.3" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="3.1.3">
+    <PackageReference Include="xunit.runner.visualstudio" Version="3.1.4">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>

Cake.Frosting.Issues.Recipe/Cake.Frosting.Issues.Recipe.Tests/CakeContextFixture.cs

@@ -0,0 +1,53 @@
+namespace Cake.Frosting.Issues.Recipe.Tests;
+
+using Cake.Core;
+using Cake.Core.Configuration;
+using Cake.Core.Diagnostics;
+using Cake.Core.IO;
+using Cake.Core.Tooling;
+using NSubstitute;
+
+internal sealed class CakeContextFixture
+{
+    public IFileSystem FileSystem { get; set; }
+    public ICakeEnvironment Environment { get; set; }
+    public IGlobber Globber { get; set; }
+    public ICakeLog Log { get; set; }
+    public ICakeArguments Arguments { get; set; }
+    public IProcessRunner ProcessRunner { get; set; }
+    public IRegistry Registry { get; set; }
+    public IToolLocator Tools { get; set; }
+    public ICakeDataService Data { get; set; }
+    public ICakeConfiguration Configuration { get; set; }
+
+    public CakeContextFixture()
+    {
+        this.Environment = new FakeEnvironment(PlatformFamily.Linux)
+        {
+            WorkingDirectory = new DirectoryPath(Directory.GetCurrentDirectory())
+        };
+        this.FileSystem = new FileSystem();
+        this.Globber = Substitute.For<IGlobber>();
+        this.Log = new FakeLog();
+        this.Arguments = Substitute.For<ICakeArguments>();
+        this.ProcessRunner = Substitute.For<IProcessRunner>();
+        this.Registry = Substitute.For<IRegistry>();
+        this.Tools = Substitute.For<IToolLocator>();
+        this.Data = Substitute.For<ICakeDataService>();
+        this.Configuration = new FakeConfiguration();
+    }
+
+    public IssuesContext CreateContext() => new(
+        new CakeContext(
+            this.FileSystem,
+            this.Environment,
+            this.Globber,
+            this.Log,
+            this.Arguments,
+            this.ProcessRunner,
+            this.Registry,
+            this.Tools,
+            this.Data,
+            this.Configuration),
+        RepositoryInfoProviderType.Cli);
+}