Pulsewave.Box.Recipe 1.0.2-beta.20230326095016

Pulsewave.Box.Recipe

====================

Re-usable cake scripts to build, test, deploy, codeql, dependenbot, mutation testing, release for any projects.

Table of content

• Pulsewave.Box.Recipe
  • Table of content
  • Documentation
    • Entry point
    • Commands
    • options
    • Project
      • Constructor
      • Properties
      • Methods
        • ToString
    • ProjectSettings
      • Properties
    • Metadata
      • Constructor
      • Properties
    • Configuration
      • Constructor
      • Properties
    • BuildConfiguration
    • NuGetPackage
      • Constructor
      • Properties
      • Methods
        • ToString
    • ICakeContext extensions
      • Clean
      • GetVersion

Documentation

Entry point

You should add a entry point to run all cake commands. This project and all box nugets follow a standard but it is not necessary to follow this standard for your own project.

• the entry point file should be named as main.cake
• Should load Pulsewave.Box.Recipe nuget with latest version
• Should setup the project information
• Should have RunTarget(Argument<string>("run")); at the end of the file

Here an example

// use the latest version
#load nuget:?package=Pulsewave.Box.Recipe&version=1.0.2

// Setup the main with a project.
Setup(context =>
{
    // The project on which the tasks are based
    Project project = new(context, new ProjectSettings
    {
        ProjectPath = "./src/Pulsewave.Box.Recipe/Pulsewave.Box.Recipe.csproj"
    });

    // Display additional information like the cake version and the project.
    Information($"Using Cake with the version: {context.GetVersion()}\n");
    Information(project);

    return project;
});

// You can add any task that you need like cleanup the folders, send an email, etc...

// The runner to run any command.
RunTarget(Argument<string>("run"));

Commands

• [command] is required to run a cake task.
• --[options] is a optional key/value pair.

dotnet cake main.cake --run [command] --[options]

options

• dev NuGet source push to nugettest.org which is a testing environment for nugets.
• prod NuGet source push to nuget.org.
• validate is a tool from dotnet: dotnet tool install dotnet-validate --version 0.0.1-preview.42

Project

Represent a project with predefined configurations.

Constructor

Initializes a new instance of the Project

• context: The context.
• settings: the project settings.

Project(ISetupContext context, ProjectSettings settings)

Properties

Methods

ToString

Gets the project information.

The formatted string follow this format

Configuring {Name} in {Configuration.BuildConfiguration} build with arguments:
generate code coverage: {Metadata.HasCodeCoverageArgument}
restore/build all projects: {Metadata.HasAllArgument}

ProjectSettings

Represents the settings for a project.

Properties

Metadata

Represent additional data for a project.

Constructor

Initializes a new instance of the Metadata

• context: The context.
• projectPath: The project path.

Metadata(ISetupContext context, FilePath projectPath)

Properties

Configuration

Represent the project configuration.

Constructor

Initializes a new instance of the Configuration

• context: The context.
• hasCodeCoverageArgument: Value indicating whether have code coverage argument or not.

Configuration(ICakeContext context, bool hasCodeCoverageArgument)

Properties

BuildConfiguration

Represent the build configuration.

NuGetPackage

Represent a NuGet package.

Constructor

Initializes a new instance of the NuGetPackage

• context: The context.
• project: the project.

NuGetPackage(ICakeContext context, Project project)

Properties

Methods

ToString

Gets the NuGet information.

The formatted string follow this format

{Name}.{Version}\n

ICakeContext extensions

Clean

Clean all folders based on a glob pattern.

• context: The ICakeContext context.
• pattern: The pattern to search folders to be cleaned.

void Clean(this ICakeContext context, GlobPattern pattern)

GetVersion

Gets the cake version.

• context: The ICakeContext context.

string GetVersion(this ICakeContext context)