ICakeContext Interface

Summary

Represents a context for scripts and script aliases.
graph TD Type["ICakeContext"] class Type type-node Type-.->Implementing0["TaskTeardownContext"] click Implementing0 "/api/Cake.Core/TaskTeardownContext" Type-.->Implementing1["CakeContextAdapter"] click Implementing1 "/api/Cake.Core/CakeContextAdapter" Type-.->Implementing2["TaskSetupContext"] click Implementing2 "/api/Cake.Core/TaskSetupContext" Type-.->Implementing3["ITaskSetupContext"] click Implementing3 "/api/Cake.Core/ITaskSetupContext" Type-.->Implementing4["CakeContext"] click Implementing4 "/api/Cake.Core/CakeContext" Type-.->Implementing5["ITaskTeardownContext"] click Implementing5 "/api/Cake.Core/ITaskTeardownContext" Type-.->Implementing6["TeardownContext"] click Implementing6 "/api/Cake.Core/TeardownContext" Type-.->Implementing7["ITeardownContext"] click Implementing7 "/api/Cake.Core/ITeardownContext"

Syntax

public interface ICakeContext

Properties

Name Value Summary
Arguments ICakeArguments
Gets the arguments.
Environment ICakeEnvironment
Gets the environment.
FileSystem IFileSystem
Gets the file system.
Globber IGlobber
Gets the globber.
Log ICakeLog
Gets the log.
ProcessRunner IProcessRunner
Gets the process runner.
Registry IRegistry
Gets the registry.
Tools IToolLocator
Gets the tool locator.

Extension Methods

Name Value Summary
AppVeyor() IAppVeyorProvider
Gets a AppVeyorProvider instance that can be used to manipulate the AppVeyor environment.
Argument<T>(string) T
Gets an argument and throws if the argument is missing.
Argument<T>(string, T) T
Gets an argument and returns the provided defaultValue if the argument is missing.
Bamboo() IBambooProvider
Gets a BambooProvider instance that can be used to manipulate the Bamboo environment.
BitbucketPipelines() IBitbucketPipelinesProvider
Gets a BitbucketPipelinesProvider instance that can be used to obtain information from the Bitbucket Pipelines environment.
Bitrise() IBitriseProvider
Gets a BitriseProvider instance that can be used to obtain information from the Bitrise environment.
BuildSystem() BuildSystem
Gets a BuildSystem instance that can be used to query for information about the current build system.
CakeExecuteExpression(string) void
Executes Cake expression out of process
CakeExecuteExpression(string, CakeSettings) void
Executes Cake expression out of process
CakeExecuteScript(FilePath) void
Executes cake script out of process
CakeExecuteScript(FilePath, CakeSettings) void
Executes cake script out of process
CalculateFileHash(FilePath) FileHash
Calculates the hash for a given file using the default (SHA256) algorithm.
CalculateFileHash(FilePath, HashAlgorithm) FileHash
Calculates the hash for a given file.
ChocolateyAddSource(string, string) void
Adds Chocolatey package source using the specified name &source to global user config
ChocolateyAddSource(string, string, ChocolateySourcesSettings) void
Adds Chocolatey package source using the specified name, source & settings to global user config
ChocolateyApiKey(string, string, ChocolateyApiKeySettings) void
Sets the Api Key for a Chocolatey Source using the specified settings.
ChocolateyConfig(string, string, ChocolateyConfigSettings) void
Sets the config parameter using the specified settings.
ChocolateyDisableFeature(string) void
Disables a Chocolatey Feature using the specified name
ChocolateyDisableFeature(string, ChocolateyFeatureSettings) void
Disables a Chocolatey Feature using the specified name and settings
ChocolateyDisableSource(string) void
Disables a Chocolatey Source using the specified name
ChocolateyDisableSource(string, ChocolateySourcesSettings) void
Disables a Chocolatey Source using the specified name and settings
ChocolateyDownload(string) void
Downloads a Chocolatey package to the current working directory.
ChocolateyDownload(string, ChocolateyDownloadSettings) void
Downloads a Chocolatey package using the specified settings.
ChocolateyEnableFeature(string) void
Enables a Chocolatey Feature using the specified name
ChocolateyEnableFeature(string, ChocolateyFeatureSettings) void
Enables a Chocolatey Feature using the specified name and settings
ChocolateyEnableSource(string) void
Enables a Chocolatey Source using the specified name
ChocolateyEnableSource(string, ChocolateySourcesSettings) void
Enables a Chocolatey Source using the specified name and settings
ChocolateyInstall(string) void
Installs a Chocolatey package.
ChocolateyInstall(string, ChocolateyInstallSettings) void
Installs a Chocolatey package using the specified settings.
ChocolateyInstallFromConfig(FilePath) void
Installs Chocolatey packages using the specified package configuration.
ChocolateyInstallFromConfig(FilePath, ChocolateyInstallSettings) void
Installs Chocolatey packages using the specified package configuration and settings.
ChocolateyNew(string) void
Generate package specification files for a new package using the default settings.
ChocolateyNew(string, ChocolateyNewSettings) void
Generate package specification files for a new package using the specified settings.
ChocolateyPack(ChocolateyPackSettings) void
Creates a Chocolatey package using the specified settings.
ChocolateyPack(FilePath, ChocolateyPackSettings) void
Creates a Chocolatey package using the specified Nuspec file.
ChocolateyPack(IEnumerable<FilePath>, ChocolateyPackSettings) void
Creates Chocolatey packages using the specified Nuspec files.
ChocolateyPin(string, ChocolateyPinSettings) void
Pins a Chocolatey package using the specified settings.
ChocolateyPush(FilePath, ChocolateyPushSettings) void
Pushes a Chocolatey package to a Chocolatey server and publishes it.
ChocolateyPush(IEnumerable<FilePath>, ChocolateyPushSettings) void
Pushes Chocolatey packages to a Chocolatey server and publishes them.
ChocolateyRemoveSource(string) void
Removes Chocolatey package source using the specified name & source from global user config
ChocolateyRemoveSource(string, ChocolateySourcesSettings) void
Removes Chocolatey package source using the specified name, source & settings from global user config
ChocolateyUninstall(IEnumerable<string>) void
Uninstalls a Chocolatey package.
ChocolateyUninstall(IEnumerable<string>, ChocolateyUninstallSettings) void
Uninstalls Chocolatey packages using the specified settings.
ChocolateyUninstall(string) void
Uninstalls a Chocolatey package.
ChocolateyUninstall(string, ChocolateyUninstallSettings) void
Uninstalls a Chocolatey package using the specified settings.
ChocolateyUpgrade(string) void
Upgrades Chocolatey package.
ChocolateyUpgrade(string, ChocolateyUpgradeSettings) void
Upgrades Chocolatey package using the specified settings.
CleanDirectories(IEnumerable<DirectoryPath>) void
Cleans the specified directories. Cleaning a directory will remove all its content but not the directory itself.
CleanDirectories(IEnumerable<string>) void
Cleans the specified directories. Cleaning a directory will remove all its content but not the directory itself.
CleanDirectories(string) void
Cleans the directories matching the specified pattern. Cleaning the directory will remove all its content but not the directory itself.
CleanDirectories(string, Func<IFileSystemInfo, bool>) void
Cleans the directories matching the specified pattern. Cleaning the directory will remove all its content but not the directory itself.
CleanDirectory(DirectoryPath) void
Cleans the specified directory.
CleanDirectory(DirectoryPath, Func<IFileSystemInfo, bool>) void
Cleans the specified directory.
ContinuaCI() IContinuaCIProvider
Gets a ContinuaCIProvider instance that can be used to manipulate the Continua CI environment.
CopyDirectory(DirectoryPath, DirectoryPath) void
Copies the contents of a directory, including subdirectories to the specified location.
CopyFile(FilePath, FilePath) void
Copies an existing file to a new file, providing the option to specify a new file name.
CopyFiles(IEnumerable<FilePath>, DirectoryPath) void
Copies existing files to a new location.
CopyFiles(IEnumerable<FilePath>, DirectoryPath, bool) void
Copies existing files to a new location.
CopyFiles(IEnumerable<string>, DirectoryPath) void
Copies existing files to a new location.
CopyFiles(IEnumerable<string>, DirectoryPath, bool) void
Copies existing files to a new location.
CopyFiles(string, DirectoryPath) void
Copies all files matching the provided pattern to a new location.
CopyFiles(string, DirectoryPath, bool) void
Copies all files matching the provided pattern to a new location.
CopyFileToDirectory(FilePath, DirectoryPath) void
Copies an existing file to a new location.
CreateAssemblyInfo(FilePath, AssemblyInfoSettings) void
Creates an assembly information file.
CreateDirectory(DirectoryPath) void
Creates the specified directory.
Debug(LogAction) void
Writes a debug message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
Debug(object) void
Writes a debug message to the log using the specified value.
Debug(string) void
Writes a debug message to the log using the specified string value.
Debug(string, object[]) void
Writes a debug message to the log using the specified format information.
DeleteDirectories(IEnumerable<DirectoryPath>, bool) void
Deletes the specified directories.
DeleteDirectories(IEnumerable<DirectoryPath>, DeleteDirectorySettings) void
Deletes the specified directories.
DeleteDirectories(IEnumerable<string>, bool) void
Deletes the specified directories.
DeleteDirectories(IEnumerable<string>, DeleteDirectorySettings) void
Deletes the specified directories.
DeleteDirectory(DirectoryPath, bool) void
Deletes the specified directory.
DeleteDirectory(DirectoryPath, DeleteDirectorySettings) void
Deletes the specified directory.
DeleteFile(FilePath) void
Deletes the specified file.
DeleteFiles(IEnumerable<FilePath>) void
Deletes the specified files.
DeleteFiles(string) void
Deletes the specified files.
Directory(string) ConvertableDirectoryPath
Gets a directory path from string.
DirectoryExists(DirectoryPath) bool
Determines whether the given path refers to an existing directory.
DotCoverAnalyse(Action<ICakeContext>, FilePath, DotCoverAnalyseSettings) void
Runs DotCover Analyse for the specified action and settings.
DotCoverCover(Action<ICakeContext>, FilePath, DotCoverCoverSettings) void
Runs DotCover Cover for the specified action and settings.
DotCoverMerge(IEnumerable<FilePath>, FilePath) void
Runs DotCover Merge for the specified action and settings.
DotCoverMerge(IEnumerable<FilePath>, FilePath, DotCoverMergeSettings) void
Runs DotCover Merge for the specified action and settings.
DotCoverReport(FilePath, FilePath, DotCoverReportSettings) void
Runs DotCover Report for the specified action and settings.
DotNetBuild(FilePath) void
Builds the specified solution using MSBuild or XBuild.
DotNetBuild(FilePath, Action<DotNetBuildSettings>) void
Builds the specified solution using MSBuild or XBuild.
DotNetCoreBuild(string) void
Build all projects.
DotNetCoreBuild(string, DotNetCoreBuildSettings) void
Build all projects.
DotNetCoreClean(string) void
Cleans a project's output.
DotNetCoreClean(string, DotNetCoreCleanSettings) void
Cleans a project's output.
DotNetCoreExecute(FilePath) void
Execute an assembly.
DotNetCoreExecute(FilePath, ProcessArgumentBuilder) void
Execute an assembly with arguments in the specific path.
DotNetCoreExecute(FilePath, ProcessArgumentBuilder, DotNetCoreExecuteSettings) void
Execute an assembly with arguments in the specific path with settings.
DotNetCoreMSBuild() void
Builds the specified targets in a project file found in the current working directory.
DotNetCoreMSBuild(DotNetCoreMSBuildSettings) void
Builds the specified targets in a project file found in the current working directory.
DotNetCoreMSBuild(string) void
Builds the specified targets in the project file.
DotNetCoreMSBuild(string, DotNetCoreMSBuildSettings) void
Builds the specified targets in the project file.
DotNetCoreNuGetDelete() void
Delete a NuGet Package from a server.
DotNetCoreNuGetDelete(DotNetCoreNuGetDeleteSettings) void
Deletes a package from a server using the specified settings.
DotNetCoreNuGetDelete(string) void
Deletes a package from the NuGet.org.
DotNetCoreNuGetDelete(string, DotNetCoreNuGetDeleteSettings) void
Deletes a package from a server
DotNetCoreNuGetDelete(string, string) void
Deletes a specific version of a package from the NuGet.org.
DotNetCoreNuGetDelete(string, string, DotNetCoreNuGetDeleteSettings) void
Deletes a package from a server using the specified settings.
DotNetCoreNuGetPush(string) void
Pushes one or more packages to a server.
DotNetCoreNuGetPush(string, DotNetCoreNuGetPushSettings) void
Pushes one or more packages to a server using the specified settings.
DotNetCorePack(string) void
Package all projects.
DotNetCorePack(string, DotNetCorePackSettings) void
Package all projects.
DotNetCorePublish(string) void
Publish all projects.
DotNetCorePublish(string, DotNetCorePublishSettings) void
Publish all projects.
DotNetCoreRestore() void
Restore all NuGet Packages.
DotNetCoreRestore(DotNetCoreRestoreSettings) void
Restore all NuGet Packages with the settings.
DotNetCoreRestore(string) void
Restore all NuGet Packages in the specified path.
DotNetCoreRestore(string, DotNetCoreRestoreSettings) void
Restore all NuGet Packages in the specified path with settings.
DotNetCoreRun() void
Run all projects.
DotNetCoreRun(string) void
Run project.
DotNetCoreRun(string, ProcessArgumentBuilder) void
Run project with path and arguments.
DotNetCoreRun(string, ProcessArgumentBuilder, DotNetCoreRunSettings) void
Run project with settings.
DotNetCoreTest() void
Test project.
DotNetCoreTest(string) void
Test project with path.
DotNetCoreTest(string, DotNetCoreTestSettings) void
Test project with settings.
DotNetCoreTool(FilePath, string) void
/// Execute an .NET Core Extensibility Tool.
DotNetCoreTool(FilePath, string, ProcessArgumentBuilder) void
Execute an .NET Core Extensibility Tool.
DotNetCoreTool(FilePath, string, ProcessArgumentBuilder, DotNetCoreToolSettings) void
Execute an .NET Core Extensibility Tool.
DotNetCoreVSTest(IEnumerable<FilePath>, DotNetCoreVSTestSettings) void
Test one or more specified projects with settings using the VS Test host runner.
DotNetCoreVSTest(string) void
Test one or more projects specified by a path or glob pattern using the VS Test host runner.
DotNetCoreVSTest(string, DotNetCoreVSTestSettings) void
Test one or more projects specified by a path or glob pattern with settings using the VS Test host runner.
DownloadFile(string) FilePath
Downloads the specified resource over HTTP to a temporary file.
DownloadFile(string, DownloadFileSettings) FilePath
Downloads the specified resource over HTTP to a temporary file with specified settings.
DownloadFile(string, FilePath) void
Downloads the specified resource over HTTP to the specified output path.
DownloadFile(string, FilePath, DownloadFileSettings) void
Downloads the specified resource over HTTP to the specified output path and settings.
DownloadFile(Uri) FilePath
Downloads the specified resource over HTTP to a temporary file.
DownloadFile(Uri, DownloadFileSettings) FilePath
Downloads the specified resource over HTTP to a temporary file with specified settings.
DownloadFile(Uri, FilePath, DownloadFileSettings) void
Downloads the specified resource over HTTP to the specified output path.
Dump<ICakeContext>() string
Get a basic string representation of specified object.
DupFinder(FilePath) void
Analyses the specified file with ReSharper's DupFinder. The file can either be a solution/project or a source file.
DupFinder(FilePath, DupFinderSettings) void
Analyses the specified file with ReSharper's DupFinder using the specified settings. The file can either be a solution/project or a source file.
DupFinder(IEnumerable<FilePath>) void
Analyses the specified projects with ReSharper's DupFinder. The files can either be solutions and projects or a source files.
DupFinder(IEnumerable<FilePath>, DupFinderSettings) void
Analyses the specified projects with ReSharper's DupFinder using the specified settings. The files can either be solutions and projects or a source files.
DupFinder(string) void
Analyses all files matching the specified pattern with ReSharper's DupFinder.
DupFinder(string, DupFinderSettings) void
Analyses all files matching the specified pattern with ReSharper's DupFinder, using the specified settings.
DupFinderFromConfig(FilePath) void
Runs ReSharper's DupFinder using the provided config file.
EnsureDirectoryExists(DirectoryPath) void
Creates the specified directory if it does not exist.
EnvironmentVariable(string) string
Retrieves the value of the environment variable or null if the environment variable does not exist.
EnvironmentVariables() IDictionary<TKey, TValue>
Retrieves all environment variables
Error(LogAction) void
Writes an error message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
Error(object) void
Writes an error message to the log using the specified value.
Error(string) void
Writes an error message to the log using the specified string value.
Error(string, object[]) void
Writes an error message to the log using the specified format information.
File(string) ConvertableFilePath
Gets a file path from string.
FileExists(FilePath) bool
Determines whether the given path refers to an existing file.
FileSize(FilePath) long
Gets the size of a file in bytes.
Fixie(IEnumerable<FilePath>) void
Runs all Fixie tests in the specified assemblies.
Fixie(IEnumerable<FilePath>, FixieSettings) void
Runs all Fixie tests in the specified assemblies, using the specified settings.
Fixie(IEnumerable<string>) void
Runs all Fixie tests in the specified assemblies.
Fixie(IEnumerable<string>, FixieSettings) void
Runs all Fixie tests in the specified assemblies, using the specified settings.
Fixie(string) void
Runs all Fixie tests in the assemblies matching the specified pattern.
Fixie(string, FixieSettings) void
Runs all Fixie tests in the assemblies matching the specified pattern, using the specified settings.
GetDirectories(string) DirectoryPathCollection
Gets all directory matching the specified pattern.
GetDirectories(string, Func<IDirectory, bool>) DirectoryPathCollection
Gets all directory matching the specified pattern.
GetFiles(string) FilePathCollection
Gets all files matching the specified pattern.
GetFiles(string, Func<IDirectory, bool>) FilePathCollection
Gets all files matching the specified pattern.
GetSubDirectories(DirectoryPath) DirectoryPathCollection
Gets a list of all the directories inside a directory.
GitLabCI() IGitLabCIProvider
Gets a GitLabCIProvider instance that can be used to obtain information from the GitLab CI environment.
GitLink(DirectoryPath) void
Update pdb files to link all sources. This will allow anyone to step through the source code while debugging without a symbol source server.
GitLink(DirectoryPath, GitLinkSettings) void
Update pdb files to link all sources, using specified settings. This will allow anyone to step through the source code while debugging without a symbol source server.
GitLink3(FilePath) void
Update the pdb file to link all sources. This will allow anyone to step through the source code while debugging without a symbol source server.
GitLink3(FilePath, GitLink3Settings) void
Update the pdb file to link all sources. This will allow anyone to step through the source code while debugging without a symbol source server.
GitLink3(IEnumerable<FilePath>) void
Update the pdb files to link all sources. This will allow anyone to step through the source code while debugging without a symbol source server.
GitLink3(IEnumerable<FilePath>, GitLink3Settings) void
Update the pdb files to link all sources. This will allow anyone to step through the source code while debugging without a symbol source server.
GitReleaseManagerAddAssets(string, string, string, string, string, string) void
Add Assets to an existing release.
GitReleaseManagerAddAssets(string, string, string, string, string, string, GitReleaseManagerAddAssetsSettings) void
Add Assets to an existing release using the specified settings.
GitReleaseManagerClose(string, string, string, string, string) void
Closes the milestone associated with a release.
GitReleaseManagerClose(string, string, string, string, string, GitReleaseManagerCloseMilestoneSettings) void
Closes the milestone associated with a release using the specified settings.
GitReleaseManagerCreate(string, string, string, string) void
Creates a Package Release.
GitReleaseManagerCreate(string, string, string, string, GitReleaseManagerCreateSettings) void
Creates a Package Release using the specified settings.
GitReleaseManagerExport(string, string, string, string, FilePath) void
Exports the release notes.
GitReleaseManagerExport(string, string, string, string, FilePath, GitReleaseManagerExportSettings) void
Exports the release notes using the specified settings.
GitReleaseManagerPublish(string, string, string, string, string) void
Publishes the release.
GitReleaseManagerPublish(string, string, string, string, string, GitReleaseManagerPublishSettings) void
Publishes the release using the specified settings.
GitReleaseNotes(FilePath, GitReleaseNotesSettings) void
Generates a set of release notes based on the commit history of the repository and specified settings.
GitVersion() GitVersion
Retrieves the GitVersion output.
GitVersion(GitVersionSettings) GitVersion
Retrieves the GitVersion output.
GoCD() IGoCDProvider
Gets a GoCDProvider instance that can be used to obtain information from the Go.CD environment.
HasArgument(string) bool
Determines whether or not the specified argument exist.
HasEnvironmentVariable(string) bool
Checks for the existence of a value for a given environment variable.
ILMerge(FilePath, FilePath, IEnumerable<FilePath>) void
Merges the specified assemblies.
ILMerge(FilePath, FilePath, IEnumerable<FilePath>, ILMergeSettings) void
Merges the specified assemblies.
ILRepack(FilePath, FilePath, IEnumerable<FilePath>) void
Merges the specified assemblies.
ILRepack(FilePath, FilePath, IEnumerable<FilePath>, ILRepackSettings) void
Merges the specified assemblies.
Information(LogAction) void
Writes an informational message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
Information(object) void
Writes an informational message to the log using the specified value.
Information(string) void
Writes an informational message to the log using the specified string value.
Information(string, object[]) void
Writes an informational message to the log using the specified format information.
InnoSetup(FilePath) void
Compiles the given Inno Setup script using the default settings.
InnoSetup(FilePath, InnoSetupSettings) void
Compiles the given Inno Setup script using the given settings.
InspectCode(FilePath) void
Analyses the specified solution with Resharper's InspectCode.
InspectCode(FilePath, InspectCodeSettings) void
Analyses the specified solution with Resharper's InspectCode, using the specified settings.
InspectCodeFromConfig(FilePath) void
Runs ReSharper's InspectCode using the specified config file.
IsIn<ICakeContext>(ICakeContext[]) bool
Checks if the source is contained in a list
IsRunningOnUnix() bool
Determines whether the build script running on a Unix or Linux based system.
IsRunningOnWindows() bool
Determines whether the build script is running on Windows.
Jenkins() IJenkinsProvider
Gets a JenkinsProvider instance that can be used to obtain information from the Jenkins environment.
MakeAbsolute(DirectoryPath) DirectoryPath
Makes the path absolute (if relative) using the current working directory.
MakeAbsolute(FilePath) FilePath
Makes the path absolute (if relative) using the current working directory.
MakeNSIS(FilePath) void
Compiles the given NSIS script using the default settings.
MakeNSIS(FilePath, MakeNSISSettings) void
Compiles the given NSIS script using the given settings.
MoveDirectory(DirectoryPath, DirectoryPath) void
Moves an existing directory to a new location, providing the option to specify a new directory name.
MoveFile(FilePath, FilePath) void
Moves an existing file to a new location, providing the option to specify a new file name.
MoveFiles(IEnumerable<FilePath>, DirectoryPath) void
Moves existing files to a new location.
MoveFiles(string, DirectoryPath) void
Moves existing files matching the specified pattern to a new location.
MoveFileToDirectory(FilePath, DirectoryPath) void
Moves an existing file to a new location.
MSBuild(FilePath) void
Builds the specified solution using MSBuild.
MSBuild(FilePath, Action<MSBuildSettings>) void
Builds the specified solution using MSBuild.
MSBuild(FilePath, MSBuildSettings) void
Builds the specified solution using MSBuild.
MSTest(IEnumerable<FilePath>) void
Runs all MSTest unit tests in the specified assemblies.
MSTest(IEnumerable<FilePath>, MSTestSettings) void
Runs all MSTest unit tests in the specified assemblies.
MSTest(string) void
Runs all MSTest unit tests in the assemblies matching the specified pattern.
MSTest(string, MSTestSettings) void
Runs all MSTest unit tests in the assemblies matching the specified pattern.
MyGet() IMyGetProvider
Gets a MyGetProvider instance that can be used to manipulate the MyGet environment.
NotNull<ICakeContext>(string) void
Throws an exception if the specified parameter's value is null.
NotNull<ICakeContext>(string) void
Throws an exception if the specified parameter's value is null.
NuGetAdd(string, NuGetAddSettings) void
Adds a NuGet package using package id and source.
NuGetAdd(string, string) void
Adds a NuGet package using package id and source.
NuGetAddSource(string, string) void
Adds NuGet package source using the specified name &source to global user config
NuGetAddSource(string, string, NuGetSourcesSettings) void
Adds NuGet package source using the specified name, source & settings to global user config
NuGetHasSource(string) bool
Checks whether or not a NuGet package source exists in the global user configuration, using the specified source.
NuGetHasSource(string, NuGetSourcesSettings) bool
Checks whether or not a NuGet package source exists in the global user configuration, using the specified source and settings.
NuGetInit(string, string) void
Adds all packages from source to destination.
NuGetInit(string, string, NuGetInitSettings) void
Adds all packages from source to destination using specified settings.
NuGetInstall(IEnumerable<string>) void
Installs NuGet packages.
NuGetInstall(IEnumerable<string>, NuGetInstallSettings) void
Installs NuGet packages using the specified settings.
NuGetInstall(string) void
Installs a NuGet package.
NuGetInstall(string, NuGetInstallSettings) void
Installs a NuGet package using the specified settings.
NuGetInstallFromConfig(FilePath) void
Installs NuGet packages using the specified package configuration.
NuGetInstallFromConfig(FilePath, NuGetInstallSettings) void
Installs NuGet packages using the specified package configuration and settings.
NuGetInstallFromConfig(IEnumerable<FilePath>) void
Installs NuGet packages using the specified package configurations.
NuGetInstallFromConfig(IEnumerable<FilePath>, NuGetInstallSettings) void
Installs NuGet packages using the specified package configurations and settings.
NuGetPack(FilePath, NuGetPackSettings) void
Creates a NuGet package using the specified Nuspec or project file.
NuGetPack(IEnumerable<FilePath>, NuGetPackSettings) void
Creates NuGet packages using the specified Nuspec or project files.
NuGetPack(NuGetPackSettings) void
Creates a NuGet package using the specified settings.
NuGetPush(FilePath, NuGetPushSettings) void
Pushes a NuGet package to a NuGet server and publishes it.
NuGetPush(IEnumerable<FilePath>, NuGetPushSettings) void
Pushes NuGet packages to a NuGet server and publishes them.
NuGetRemoveSource(string, string) void
Removes NuGet package source using the specified name & source from global user config
NuGetRemoveSource(string, string, NuGetSourcesSettings) void
Removes NuGet package source using the specified name, source & settings from global user config
NuGetRestore(FilePath) void
Restores NuGet packages for the specified target.
NuGetRestore(FilePath, NuGetRestoreSettings) void
Restores NuGet packages using the specified settings.
NuGetRestore(IEnumerable<FilePath>) void
Restores NuGet packages for the specified targets.
NuGetRestore(IEnumerable<FilePath>, NuGetRestoreSettings) void
Restores NuGet packages using the specified settings.
NuGetSetApiKey(string, string) void
Installs NuGet packages using the specified API key and source.
NuGetSetApiKey(string, string, NuGetSetApiKeySettings) void
Installs NuGet packages using the specified API key, source and settings.
NuGetSetProxy(string, string, string) void
Set the proxy settings to be used while connecting to your NuGet feed.
NuGetSetProxy(string, string, string, NuGetSetProxySettings) void
Set the proxy settings to be used while connecting to your NuGet feed, including settings.
NuGetUpdate(FilePath) void
Updates NuGet packages.
NuGetUpdate(FilePath, NuGetUpdateSettings) void
Updates NuGet packages using the specified settings.
NuGetUpdate(IEnumerable<FilePath>) void
Updates NuGet packages.
NuGetUpdate(IEnumerable<FilePath>, NuGetUpdateSettings) void
Updates NuGet packages using the specified settings.
NUnit(IEnumerable<FilePath>) void
Runs all NUnit unit tests in the specified assemblies.
NUnit(IEnumerable<FilePath>, NUnitSettings) void
Runs all NUnit unit tests in the specified assemblies, using the specified settings.
NUnit(IEnumerable<string>) void
Runs all NUnit unit tests in the specified assemblies.
NUnit(IEnumerable<string>, NUnitSettings) void
Runs all NUnit unit tests in the specified assemblies, using the specified settings.
NUnit(string) void
Runs all NUnit unit tests in the assemblies matching the specified pattern.
NUnit(string, NUnitSettings) void
Runs all NUnit unit tests in the assemblies matching the specified pattern, using the specified settings.
NUnit3(IEnumerable<FilePath>) void
Runs all NUnit unit tests in the specified assemblies.
NUnit3(IEnumerable<FilePath>, NUnit3Settings) void
Runs all NUnit unit tests in the specified assemblies, using the specified settings.
NUnit3(IEnumerable<string>) void
Runs all NUnit unit tests in the specified assemblies.
NUnit3(IEnumerable<string>, NUnit3Settings) void
Runs all NUnit unit tests in the specified assemblies, using the specified settings.
NUnit3(string) void
Runs all NUnit unit tests in the assemblies matching the specified pattern.
NUnit3(string, NUnit3Settings) void
Runs all NUnit unit tests in the assemblies matching the specified pattern, using the specified settings.
OctoCreateRelease(string, CreateReleaseSettings) void
Creates a release for the specified Octopus Deploy Project.
OctoDeployRelease(string, string, string, string, string, OctopusDeployReleaseDeploymentSettings) void
Deploys the specified already existing release into a specified environment See Octopus Documentation for more details.
OctoPack(string) void
Packs the specified folder into an Octopus Deploy package.
OctoPack(string, OctopusPackSettings) void
Packs the specified folder into an Octopus Deploy package.
OctoPush(string, string, FilePath, OctopusPushSettings) void
Pushes the specified package to the Octopus Deploy repository
OctoPush(string, string, IEnumerable<FilePath>, OctopusPushSettings) void
Pushes the specified packages to the Octopus Deploy repository
OpenCover(Action<ICakeContext>, FilePath, OpenCoverSettings) void
Runs OpenCover for the specified action and settings.
ParseAllReleaseNotes(FilePath) IReadOnlyList<T>
Parses all release notes.
ParseAssemblyInfo(FilePath) AssemblyInfoParseResult
Parses an existing assembly information file.
ParseProject(FilePath) ProjectParserResult
Parses project information from project file
ParseReleaseNotes(FilePath) ReleaseNotes
Parses the latest release notes.
ParseSolution(FilePath) SolutionParserResult
Parses project information from a solution file.
ParseXmlDocExampleCode(FilePath) IEnumerable<T>
Parses Xml documentation example code from given path.
ParseXmlDocFilesExampleCode(string) IEnumerable<T>
Parses Xml documentation example code from file(s) using given pattern.
ReportGenerator(FilePath, DirectoryPath) void
Converts the specified coverage report into human readable form.
ReportGenerator(FilePath, DirectoryPath, ReportGeneratorSettings) void
Converts the specified coverage report into human readable form using the specified settings.
ReportGenerator(IEnumerable<FilePath>, DirectoryPath) void
Converts the specified coverage reports into human readable form.
ReportGenerator(IEnumerable<FilePath>, DirectoryPath, ReportGeneratorSettings) void
Converts the specified coverage reports into human readable form using the specified settings.
ReportGenerator(string, DirectoryPath) void
Converts the coverage report specified by the glob pattern into human readable form.
ReportGenerator(string, DirectoryPath, ReportGeneratorSettings) void
Converts the coverage report specified by the glob pattern into human readable form using the specified settings.
ReportUnit(DirectoryPath) void
Converts the reports in the specified directory into human readable form.
ReportUnit(DirectoryPath, DirectoryPath, ReportUnitSettings) void
Converts the reports in the specified directory into human readable form and outputs to specified folder.
ReportUnit(DirectoryPath, ReportUnitSettings) void
Converts the reports in the specified directory into human readable form.
ReportUnit(FilePath, FilePath) void
Converts the single specified report into human readable form and outputs to specified file.
ReportUnit(FilePath, FilePath, ReportUnitSettings) void
Converts the single specified report into human readable form and outputs to specified file.
RoundhouseDrop(RoundhouseSettings) void
Executes Roundhouse migration to drop the database using the provided settings.
RoundhouseMigrate(RoundhouseSettings) void
Executes Roundhouse with the given configured settings.
Sign(FilePath, SignToolSignSettings) void
Signs the specified assembly.
Sign(IEnumerable<FilePath>, SignToolSignSettings) void
Signs the specified assemblies.
Sign(IEnumerable<string>, SignToolSignSettings) void
Signs the specified assemblies.
Sign(string, SignToolSignSettings) void
Signs the specified assembly.
SpecFlowStepDefinitionReport(FilePath) void
Creates a report that shows the usage and binding status of the steps for the entire project. You can use this report to find both unused code in the automation layer and scenario steps that have no definition yet. See SpecFlow Documentation for more information.
SpecFlowStepDefinitionReport(FilePath, SpecFlowStepDefinitionReportSettings) void
Creates a report that shows the usage and binding status of the steps for the entire project. You can use this report to find both unused code in the automation layer and scenario steps that have no definition yet. See SpecFlow Documentation for more information.
SpecFlowTestExecutionReport(Action<ICakeContext>, FilePath) void
Creates a formatted HTML report of a test execution. The report contains a summary about the executed tests and the result and also a detailed report for the individual scenario executions. See SpecFlow Documentation for more information.
SpecFlowTestExecutionReport(Action<ICakeContext>, FilePath, SpecFlowTestExecutionReportSettings) void
Creates a formatted HTML report of a test execution. The report contains a summary about the executed tests and the result and also a detailed report for the individual scenario executions. See SpecFlow Documentation for more information.
StartAndReturnProcess(FilePath) IProcess
Starts the process resource that is specified by the filename.
StartAndReturnProcess(FilePath, ProcessSettings) IProcess
Starts the process resource that is specified by the filename and settings.
StartProcess(FilePath) int
Starts the process resource that is specified by the filename.
StartProcess(FilePath, ProcessSettings) int
Starts the process resource that is specified by the filename and settings.
StartProcess(FilePath, ProcessSettings, IEnumerable<string>) int
Starts the process resource that is specified by the filename and settings.
StartProcess(FilePath, ProcessSettings, IEnumerable<string>, IEnumerable<string>) int
Starts the process resource that is specified by the filename and settings.
StartProcess(FilePath, string) int
Starts the process resource that is specified by the filename and arguments
TeamCity() ITeamCityProvider
Gets a TeamCityProvider instance that can be used to manipulate the TeamCity environment.
TFBuild() ITFBuildProvider
Gets a TFBuildProvider instance that can be used to obtain information from the Team Foundation Build environment.
ThrowIfNull<ICakeContext>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
ThrowIfNull<ICakeContext>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
TransformTemplate(FilePath) void
Transform a text template.
TransformTemplate(FilePath, TextTransformSettings) void
Transform a text template.
TransformText(string) TextTransformation<TTemplate>
Creates a text transformation from the provided template.
TransformText(string, string, string) TextTransformation<TTemplate>
Creates a text transformation from the provided template, using the specified placeholder.
TransformTextFile(FilePath) TextTransformation<TTemplate>
Creates a text transformation from the provided template on disc.
TransformTextFile(FilePath, string, string) TextTransformation<TTemplate>
Creates a text transformation from the provided template on disc, using the specified placeholder.
TravisCI() ITravisCIProvider
Gets a TravisCIProvider instance that can be used to obtain information from the Travis CI environment.
Unzip(FilePath, DirectoryPath) void
Unzips the specified file
UploadFile(string, byte[], string) void
Uploads the specified byte array via a HTTP POST to the specified uri using multipart/form-data.
UploadFile(string, FilePath) void
Uploads the specified file via a HTTP POST to the specified uri using multipart/form-data.
UploadFile(Uri, byte[], string) void
Uploads the specified byte array via a HTTP POST to the specified uri using multipart/form-data.
UploadFile(Uri, FilePath) void
Uploads the specified file via a HTTP POST to the specified uri using multipart/form-data.
Verbose(LogAction) void
Writes a verbose message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
Verbose(object) void
Writes a verbose message to the log using the specified value.
Verbose(string) void
Writes a verbose message to the log using the specified string value.
Verbose(string, object[]) void
Writes a verbose message to the log using the specified format information.
VSTest(IEnumerable<FilePath>) void
Runs all VSTest unit tests in the specified assemblies.
VSTest(IEnumerable<FilePath>, VSTestSettings) void
Runs all VSTest unit tests in the specified assemblies.
VSTest(string) void
Runs all VSTest unit tests in the assemblies matching the specified pattern.
VSTest(string, VSTestSettings) void
Runs all VSTest unit tests in the assemblies matching the specified pattern.
VSWhereAll() DirectoryPathCollection
Gets all Visual Studio product installation paths.
VSWhereAll(VSWhereAllSettings) DirectoryPathCollection
Gets all Visual Studio product installation paths.
VSWhereLatest() DirectoryPath
Gets the latest Visual Studio product installation path.
VSWhereLatest(VSWhereLatestSettings) DirectoryPath
Gets the latest Visual Studio product installation path.
VSWhereLegacy(bool) DirectoryPath
Gets the legacy Visual Studio product installation paths.
VSWhereLegacy(VSWhereLegacySettings) DirectoryPathCollection
Gets the legacy Visual Studio product installation paths.
VSWhereProducts(string) DirectoryPathCollection
Gets Visual Studio product installation paths.
VSWhereProducts(string, VSWhereProductSettings) DirectoryPathCollection
Gets Visual Studio product installation paths.
Warning(LogAction) void
Writes a warning message to the log using the specified log message action. Evaluation message only if verbosity same or more verbose.
Warning(object) void
Writes an warning message to the log using the specified value.
Warning(string) void
Writes an warning message to the log using the specified string value.
Warning(string, object[]) void
Writes a warning message to the log using the specified format information.
WiXCandle(IEnumerable<FilePath>, CandleSettings) void
Compiles all .wxs sources in the provided source files.
WiXCandle(string, CandleSettings) void
Compiles all .wxs sources matching the specified pattern.
WiXHeat(DirectoryPath, FilePath, WiXHarvestType) void
Harvests files in the provided object files.
WiXHeat(DirectoryPath, FilePath, WiXHarvestType, HeatSettings) void
Harvests files in the provided directory path.
WiXHeat(FilePath, FilePath, WiXHarvestType) void
Harvests from the desired files.
WiXHeat(FilePath, FilePath, WiXHarvestType, HeatSettings) void
Harvests from the desired files.
WiXHeat(string, FilePath, WiXHarvestType) void
Harvests files for a website or performance.
WiXHeat(string, FilePath, WiXHarvestType, HeatSettings) void
Harvests files for a website or performance.
WiXLight(IEnumerable<FilePath>, LightSettings) void
Links all .wixobj files in the provided object files.
WiXLight(string, LightSettings) void
Links all .wixobj files matching the specified pattern.
XBuild(FilePath) void
Builds the specified solution using XBuild.
XBuild(FilePath, Action<XBuildSettings>) void
Builds the specified solution using XBuild.
XBuild(FilePath, XBuildSettings) void
Builds the specified solution using XBuild.
XmlPeek(FilePath, string) string
Gets the value of a target node.
XmlPeek(FilePath, string, XmlPeekSettings) string
Get the value of a target node.
XmlPoke(FilePath, string, string) void
Set the value of, or remove, target nodes.
XmlPoke(FilePath, string, string, XmlPokeSettings) void
Set the value of, or remove, target nodes.
XmlPokeString(string, string, string) string
Set the value of, or remove, target nodes.
XmlPokeString(string, string, string, XmlPokeSettings) string
Set the value of, or remove, target nodes.
XmlTransform(FilePath, FilePath, FilePath) void
Performs XML XSL transformation
XmlTransform(FilePath, FilePath, FilePath, XmlTransformationSettings) void
Performs XML XSL transformation
XmlTransform(string, string) string
Performs XML XSL transformation
XmlTransform(string, string, XmlTransformationSettings) string
Performs XML XSL transformation
XUnit(IEnumerable<FilePath>) void
Runs all xUnit.net tests in the specified assemblies.
XUnit(IEnumerable<FilePath>, XUnitSettings) void
Runs all xUnit.net tests in the specified assemblies.
XUnit(IEnumerable<string>) void
Runs all xUnit.net tests in the specified assemblies.
XUnit(IEnumerable<string>, XUnitSettings) void
Runs all xUnit.net tests in the specified assemblies.
XUnit(string) void
Runs all xUnit.net tests in the assemblies matching the specified pattern.
XUnit(string, XUnitSettings) void
Runs all xUnit.net tests in the assemblies matching the specified pattern.
XUnit2(IEnumerable<FilePath>) void
Runs all xUnit.net tests in the specified assemblies.
XUnit2(IEnumerable<FilePath>, XUnit2Settings) void
Runs all xUnit.net v2 tests in the specified assemblies.
XUnit2(IEnumerable<string>) void
Runs all xUnit.net v2 tests in the specified assemblies.
XUnit2(IEnumerable<string>, XUnit2Settings) void
Runs all xUnit.net v2 tests in the specified assemblies.
XUnit2(string) void
Runs all xUnit.net v2 tests in the assemblies matching the specified pattern.
XUnit2(string, XUnit2Settings) void
Runs all xUnit.net v2 tests in the assemblies matching the specified pattern.
Zip(DirectoryPath, FilePath) void
Zips the specified directory.
Zip(DirectoryPath, FilePath, IEnumerable<FilePath>) void
Zips the specified files.
Zip(DirectoryPath, FilePath, IEnumerable<string>) void
Zips the specified files.
Zip(DirectoryPath, FilePath, string) void
Zips the files matching the specified pattern.