CakeHost Class

Summary

The Cake host.
Namespace
Cake.Frosting
Base Types
  • object
graph BT Type-->Base0["object"] Type["CakeHost"] class Type type-node

Syntax

public sealed class CakeHost

Constructors

Name Summary
CakeHost() Initializes a new instance of the CakeHost class.

Methods

Name Value Summary
AddAssembly(Assembly) CakeHost
Registers an assembly which will be used to find tasks.
ConfigureServices(Action<IServiceCollection>) CakeHost
Adds a delegate for configuring additional services for the host.
Create() CakeHost
Creates a CakeHost.
static
Run(IEnumerable<string>) int
Runs the build with the specified arguments.

Extension Methods

Name Value Summary
Dump<CakeHost>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
InstallTool(Uri) CakeHost
Registers a specific tool for installation.
IsIn<CakeHost>(CakeHost[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<CakeHost>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<CakeHost>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
SetToolPath(DirectoryPath) CakeHost
Sets the specified path as the path where tools and addins will be installed.
ThrowIfNull<CakeHost>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<CakeHost>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
UseCakeSetting(string, string) CakeHost
Sets the specified Cake setting to the specified value.
UseContext<TContext>() CakeHost
Registers the specified context type. Only the last registration will be used.
UseLifetime<TLifetime>() CakeHost
Registers the specified lifetime type. Only the last registration will be used.
UseModule<TModule>() CakeHost
Registers the specified module type.
UsePackageInstaller<TPackageInstaller>() CakeHost
Registers a package installer.
UseSetup<TSetup>() CakeHost
Registers a setup action.
UseStartup<TStartup>() CakeHost
Specify the startup type to be used by the Cake host.
UseTaskLifetime<TLifetime>() CakeHost
Registers the specified task lifetime type. Only the last registration will be used.
UseTaskSetup<TSetup>() CakeHost
Registers a task setup action.
UseTaskTeardown<TTeardown>() CakeHost
Registers a task teardown action.
UseTeardown<TTeardown>() CakeHost
Registers a teardown action.
UseWorkingDirectory(DirectoryPath) CakeHost
Sets the relative working directory to be used when running the build.