This reference guide describes the various methods and properties which you can use directly from inside a Cake build script. These are implemented as script aliases.
Click on any alias to get detailed information about parameters and examples how to use the alias.
General
Code Analysis Provider
DocFxIssues |
Gets an instance of a provider for warnings reported by DocFx using specified settings.
Addin from Cake |
Doc |
Gets an instance of a provider for warnings reported by DocFx using log file content
for a DocFx project in the repository root.
Addin from Cake |
Doc |
Gets an instance of a provider for warnings reported by DocFx using log file content.
Addin from Cake |
Doc |
Gets an instance of a provider for warnings reported by DocFx using a log file from disk
for a DocFx project in the repository root.
Addin from Cake |
Doc |
Gets an instance of a provider for warnings reported by DocFx using a log file from disk.
Addin from Cake |
Es |
Registers a new URL resolver with default priority of 0.
Addin from Cake |
Es |
Registers a new URL resolver with a specific priority.
Addin from Cake |
EsLintIssues |
Gets an instance of a provider for code analysis issues reported by ESLint using specified settings.
Addin from Cake |
Es |
Gets an instance of a provider for code analysis issues reported by ESLint using log file content.
Addin from Cake |
Es |
Gets an instance of a provider for code analysis issues reported by ESLint using a log file from disk.
Addin from Cake |
EsLintJsonFormat |
Gets an instance for the ESLint JSON log format as written by the JSON formatter.
Addin from Cake |
InspectCodeIssues |
Gets an instance of a provider for code analysis issues reported by JetBrains Inspect Code using specified settings.
Addin from Cake |
Inspect |
Gets an instance of a provider for code analysis issues reported by JetBrains Inspect Code using log file content.
Addin from Cake |
Inspect |
Gets an instance of a provider for code analysis issues reported by JetBrains Inspect Code using a log file from disk.
Addin from Cake |
MarkdownlintIssues |
Gets an instance of a provider for code analysis issues reported by Markdownlint using specified settings.
Addin from Cake |
Markdownlint |
Gets an instance of a provider for code analysis issues reported by Markdownlint using log file content.
Addin from Cake |
Markdownlint |
Gets an instance of a provider for code analysis issues reported by Markdownlint using a log file from disk.
Addin from Cake |
Ms |
Registers a new URL resolver with default priority of 0.
Addin from Cake |
Ms |
Registers a new URL resolver with a specific priority.
Addin from Cake |
MsBuildIssues |
Gets an instance of a provider for code analysis issues reported as MsBuild warnings using specified settings.
Addin from Cake |
Ms |
Gets an instance of a provider for code analysis issues reported as MsBuild warnings using log content.
Addin from Cake |
Ms |
Gets an instance of a provider for code analysis issues reported as MsBuild warnings using a log file from disk.
Addin from Cake |
Ms |
Gets an instance for the MsBuild log format as written by the You can add the logger to the MSBuildSettings like this:
In order to use the above logger, include the following in your build.cake file to download and install from NuGet.org:
Addin from Cake |
Pull Request System
Tfs |
Returns credentials for authentication with an Azure Active Directory.
Addin from Cake |
Tfs |
Returns credentials for basic authentication.
Can only be used for on-premise Team Foundation Server configured for basic authentication.
See https://www.visualstudio.com/en-us/docs/integrate/get-started/auth/tfs-basic-auth.
Addin from Cake |
Tfs |
Returns credentials for integrated / NTLM authentication.
Can only be used for on-premise Team Foundation Server.
Addin from Cake |
Tfs |
Returns credentials for OAuth authentication.
Can only be used with Visual Studio Team Services.
Addin from Cake |
Tfs |
Returns credentials for authentication with a personal access token.
Can be used for Team Foundation Server and Visual Studio Team Services.
Addin from Cake |
TfsPullRequests |
Gets an object for writing issues to Team Foundation Server or Visual Studio Team Services pull request
using the specified settings.
Addin from Cake |
TfsPullRequests |
Gets an object for writing issues to Team Foundation Server or Visual Studio Team Services pull request
in a specific repository and with a specific ID.
Addin from Cake |
TfsPullRequests |
Gets an object for writing issues to Team Foundation Server or Visual Studio Team Services pull request
in a specific repository and for a specific source branch.
Addin from Cake |
TfsVotePullRequest |
Votes for the Team Foundation Server or Visual Studio Team Services pull request
using the specified settings.
Addin from Cake |