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.
Creating Issue Reports
Creating Issues
NewIssue |
Initiates the creation of a new IIssue with message as identifier.
Addin from Cake |
NewIssue |
Initiates the creation of a new IIssue .
Addin from Cake |
File Linking
Issue |
Gets an instance of the file link settings for linking to files
based on a custom action.
Addin from Cake |
Issue |
Gets an instance of the file link settings for linking to files
based on a custom pattern.
Addin from Cake |
Issue |
Gets an instance of the file link settings for linking to files hosted in Azure DevOps
on a specific branch.
Addin from Cake |
Issue |
Gets an instance of the file link settings for linking to files hosted in Azure DevOps
in a sub-folder on a specific branch.
Addin from Cake |
Issue |
Gets an instance of the file link settings for linking to files hosted in Azure DevOps
for a specific commit.
Addin from Cake |
Issue |
Gets an instance of the file link settings for linking to files hosted in Azure DevOps
in a sub-folder for a specific commit.
Addin from Cake |
Issue |
Gets an instance of the file link settings for linking files hosted on GitHub on a specific branch.
Addin from Cake |
Issue |
Gets an instance of the file link settings for linking files hosted on GitHub
in a sub-folder on a specific branch.
Addin from Cake |
Issue |
Gets an instance of the file link settings for linking files hosted on GitHub fo a specific commit.
Addin from Cake |
Issue |
Gets an instance of the file link settings for linking files hosted on GitHub
in a sub-folder for a specific commit.
Addin from Cake |
Issue Providers
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 |
Doc |
Gets the name of the DocFx issue provider.
This name can be used to identify issues based on the ProviderType property.
Addin from Cake |
DupFinderIssues |
Gets an instance of a provider for issues reported by JetBrains dupFinder using specified settings.
Addin from Cake |
Dup |
Gets an instance of a provider for issues reported by JetBrains dupFinder using log file content.
Addin from Cake |
Dup |
Gets an instance of a provider for issues reported by JetBrains dupFinder using a log file from disk.
Addin from Cake |
Dup |
Gets the name of the dupFinder issue provider.
This name can be used to identify issues based on the ProviderType property.
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 issues reported by ESLint using specified settings.
Addin from Cake |
Es |
Gets an instance of a provider for issues reported by ESLint using log file content.
Addin from Cake |
Es |
Gets an instance of a provider for issues reported by ESLint using a log file from disk.
Addin from Cake |
Es |
Gets the name of the ESLint issue provider.
This name can be used to identify issues based on the ProviderType property.
Addin from Cake |
EsLintJsonFormat |
Gets an instance for the ESLint JSON log format as written by the JSON formatter.
Addin from Cake |
GitRepositoryIssues |
Gets an instance of a provider for analyzing a Git repository and reporting issues using specified settings.
Addin from Cake |
Git |
Gets the name of the Git repository issue provider.
This name can be used to identify issues based on the ProviderType property.
Addin from Cake |
InspectCodeIssues |
Gets an instance of a provider for issues reported by JetBrains Inspect Code using specified settings.
Addin from Cake |
Inspect |
Gets an instance of a provider for issues reported by JetBrains Inspect Code using log file content.
Addin from Cake |
Inspect |
Gets an instance of a provider for issues reported by JetBrains Inspect Code using a log file from disk.
Addin from Cake |
Inspect |
Gets the name of the Inspect Code issue provider.
This name can be used to identify issues based on the ProviderType property.
Addin from Cake |
Markdownlint |
Registers a new URL resolver with default priority of 0.
Addin from Cake |
Markdownlint |
Registers a new URL resolver with a specific priority.
Addin from Cake |
Markdownlint |
Gets an instance for the log format as written by markdownlint-cli with --json parameter.
Addin from Cake |
Markdownlint |
Gets an instance for the log format as written by markdownlint-cli.
Addin from Cake |
MarkdownlintIssues |
Gets an instance of a provider for issues reported by Markdownlint using specified settings.
Addin from Cake |
Markdownlint |
Gets an instance of a provider for issues reported by Markdownlint using log file content.
Addin from Cake |
Markdownlint |
Gets an instance of a provider for issues reported by Markdownlint using a log file from disk.
Addin from Cake |
Markdownlint |
Gets the name of the Markdownlint issue provider.
This name can be used to identify issues based on the ProviderType property.
Addin from Cake |
Markdownlint |
Gets an instance for the log format as written by Markdownlint with options.resultVersion set to 1.
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 |
Ms |
Gets an instance for the MsBuild binary log format.
Addin from Cake |
MsBuildIssues |
Gets an instance of a provider for issues reported as MsBuild warnings using specified settings.
Addin from Cake |
Ms |
Gets an instance of a provider for issues reported as MsBuild warnings using log content.
Addin from Cake |
Ms |
Gets an instance of a provider for issues reported as MsBuild warnings using a log file from disk.
Addin from Cake |
Ms |
Gets the name of the MsBuild issue provider.
This name can be used to identify issues based on the ProviderType property.
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 |
TerraformIssues |
Gets an instance of a provider for reading output from terraform validate -json using specified settings.
Addin from Cake |
Terraform |
Gets an instance of a provider for reading output from terraform validate -json
for Terraform scripts in the repository root.
Addin from Cake |
Terraform |
Gets an instance of a provider for reading output from terraform validate -json .
Addin from Cake |
Terraform |
Gets an instance of a provider for reading output from terraform validate -json from disk
for Terraform scripts in the repository root.
Addin from Cake |
Terraform |
Gets an instance of a provider for reading output from terraform validate -json from disk.
Addin from Cake |
Terraform |
Gets the name of the Terraform issue provider.
This name can be used to identify issues based on the ProviderType property.
Addin from Cake |
Issue Serialization
Pull Request Systems
AppVeyorBuilds |
Gets an object for writing issues to AppVeyor builds using the default settings.
Addin from Cake |
AppVeyorBuilds |
Gets an object for writing issues to AppVeyor builds using the specified settings.
Addin from Cake |
Azure |
Gets an object for writing issues to Azure DevOps pull request where all required data (including authentication token)
is taken from the environment variables set by Azure Pipelines.
Addin from Cake |
Azure |
Gets an object for writing issues to Azure DevOps pull request using the specified settings.
Addin from Cake |
Azure |
Gets an object for writing issues to Azure DevOps pull request where all required data is taken
from the environment variables set by Azure Pipelines.
Addin from Cake |
Azure |
Gets an object for writing issues to Azure DevOps pull request in a specific repository and with a specific ID.
Addin from Cake |
Azure |
Gets an object for writing issues to Azure DevOps pull request in a specific repository and for a
specific source branch.
Addin from Cake |
GitHubActionsBuilds |
Gets an object for writing issues to GitHub Actions using the default settings.
Addin from Cake |
GitHubActionsBuilds |
Gets an object for writing issues to GitHub Actions using the specified settings.
Addin from Cake |
Reading Issues
ReadIssues |
Reads issues from issue providers.
Addin from Cake |
ReadIssues |
Reads issues from issue providers using the specified settings.
Addin from Cake |
ReadIssues |
Reads issues from a single issue provider.
Addin from Cake |
ReadIssues |
Reads issues from a single issue provider using the specified settings.
Addin from Cake |