Issues aliases

Cake.Issues addin

Contains functionality related to reading and creating issues.

Creating Issues

NewIssue(string, string, string)
Alias from Cake.Issues addin
Initiates the creation of a new IIssue with message as identifier.
NewIssue(string, string, string, string)
Alias from Cake.Issues addin
Initiates the creation of a new IIssue.

File Linking

IssueFileLinkSettings(Func<IIssue, Uri>)
Alias from Cake.Issues addin
Gets an instance of the file link settings for linking to files based on a custom action.
IssueFileLinkSettings(string)
Alias from Cake.Issues addin
Gets an instance of the file link settings for linking to files based on a custom pattern.
IssueFileLinkSettingsForAzureDevOpsBranch(Uri, string)
Alias from Cake.Issues addin
Gets an instance of the file link settings for linking to files hosted in Azure DevOps on a specific branch.
IssueFileLinkSettingsForAzureDevOpsBranch(Uri, string, string)
Alias from Cake.Issues addin
Gets an instance of the file link settings for linking to files hosted in Azure DevOps in a sub-folder on a specific branch.
IssueFileLinkSettingsForAzureDevOpsCommit(Uri, string)
Alias from Cake.Issues addin
Gets an instance of the file link settings for linking to files hosted in Azure DevOps for a specific commit.
IssueFileLinkSettingsForAzureDevOpsCommit(Uri, string, string)
Alias from Cake.Issues addin
Gets an instance of the file link settings for linking to files hosted in Azure DevOps in a sub-folder for a specific commit.
IssueFileLinkSettingsForGitHubBranch(Uri, string)
Alias from Cake.Issues addin
Gets an instance of the file link settings for linking files hosted on GitHub on a specific branch.
IssueFileLinkSettingsForGitHubBranch(Uri, string, string)
Alias from Cake.Issues addin
Gets an instance of the file link settings for linking files hosted on GitHub in a sub-folder on a specific branch.
IssueFileLinkSettingsForGitHubCommit(Uri, string)
Alias from Cake.Issues addin
Gets an instance of the file link settings for linking files hosted on GitHub fo a specific commit.
IssueFileLinkSettingsForGitHubCommit(Uri, string, string)
Alias from Cake.Issues addin
Gets an instance of the file link settings for linking files hosted on GitHub in a sub-folder for a specific commit.

Issue Serialization

DeserializeIssueFromJsonFile(FilePath)
Alias from Cake.Issues addin
Deserializes an Issue from a JSON file.
DeserializeIssueFromJsonString(string)
Alias from Cake.Issues addin
Deserializes an Issue from a JSON string.
DeserializeIssuesFromJsonFile(FilePath)
Alias from Cake.Issues addin
Deserializes an IEnumerable<T> from a JSON file.
DeserializeIssuesFromJsonString(string)
Alias from Cake.Issues addin
Deserializes an IEnumerable<T> from a JSON string.
SerializeIssuesToJsonFile(IEnumerable<IIssue>, FilePath)
Alias from Cake.Issues addin
Serializes an IEnumerable<T> to a JSON file.
SerializeIssuesToJsonString(IEnumerable<IIssue>)
Alias from Cake.Issues addin
Serializes an IEnumerable<T> to a JSON string.
SerializeIssueToJsonFile(IIssue, FilePath)
Alias from Cake.Issues addin
Serializes an IIssue to a JSON file.
SerializeIssueToJsonString(IIssue)
Alias from Cake.Issues addin
Serializes an IIssue to a JSON string.

Reading Issues

ReadIssues(IEnumerable<IIssueProvider>, DirectoryPath)
Alias from Cake.Issues addin
Reads issues from issue providers.
ReadIssues(IEnumerable<IIssueProvider>, IReadIssuesSettings)
Alias from Cake.Issues addin
Reads issues from issue providers using the specified settings.
ReadIssues(IIssueProvider, DirectoryPath)
Alias from Cake.Issues addin
Reads issues from a single issue provider.
ReadIssues(IIssueProvider, IReadIssuesSettings)
Alias from Cake.Issues addin
Reads issues from a single issue provider using the specified settings.

Cake.Issues.DocFx addin

Contains functionality related to read warnings from DocFx log files.

Issue Providers

DocFxIssues(DocFxIssuesSettings)
Alias from Cake.Issues.DocFx addin
Gets an instance of a provider for warnings reported by DocFx using specified settings.
DocFxIssuesFromContent(string)
Alias from Cake.Issues.DocFx addin
Gets an instance of a provider for warnings reported by DocFx using log file content for a DocFx project in the repository root.
DocFxIssuesFromContent(string, DirectoryPath)
Alias from Cake.Issues.DocFx addin
Gets an instance of a provider for warnings reported by DocFx using log file content.
DocFxIssuesFromFilePath(FilePath)
Alias from Cake.Issues.DocFx addin
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.
DocFxIssuesFromFilePath(FilePath, DirectoryPath)
Alias from Cake.Issues.DocFx addin
Gets an instance of a provider for warnings reported by DocFx using a log file from disk.
DocFxIssuesProviderTypeName
Alias from Cake.Issues.DocFx addin
Gets the name of the DocFx issue provider. This name can be used to identify issues based on the ProviderType property.

Cake.Issues.DupFinder addin

Contains functionality for reading issues from JetBrains dupFinder log files.

Issue Providers

DupFinderIssues(DupFinderIssuesSettings)
Alias from Cake.Issues.DupFinder addin
Gets an instance of a provider for issues reported by JetBrains dupFinder using specified settings.
DupFinderIssuesFromContent(string)
Alias from Cake.Issues.DupFinder addin
Gets an instance of a provider for issues reported by JetBrains dupFinder using log file content.
DupFinderIssuesFromFilePath(FilePath)
Alias from Cake.Issues.DupFinder addin
Gets an instance of a provider for issues reported by JetBrains dupFinder using a log file from disk.
DupFinderIssuesProviderTypeName
Alias from Cake.Issues.DupFinder addin
Gets the name of the dupFinder issue provider. This name can be used to identify issues based on the ProviderType property.

Cake.Issues.EsLint addin

Contains functionality for reading issues reported by ESLint.

Issue Providers

EsLintAddRuleUrlResolver(Func<BaseRuleDescription, Uri>)
Alias from Cake.Issues.EsLint addin
Registers a new URL resolver with default priority of 0.
EsLintAddRuleUrlResolver(Func<BaseRuleDescription, Uri>, int)
Alias from Cake.Issues.EsLint addin
Registers a new URL resolver with a specific priority.
EsLintIssues(EsLintIssuesSettings)
Alias from Cake.Issues.EsLint addin
Gets an instance of a provider for issues reported by ESLint using specified settings.
EsLintIssuesFromContent(string, BaseEsLintLogFileFormat)
Alias from Cake.Issues.EsLint addin
Gets an instance of a provider for issues reported by ESLint using log file content.
EsLintIssuesFromFilePath(FilePath, BaseEsLintLogFileFormat)
Alias from Cake.Issues.EsLint addin
Gets an instance of a provider for issues reported by ESLint using a log file from disk.
EsLintIssuesProviderTypeName
Alias from Cake.Issues.EsLint addin
Gets the name of the ESLint issue provider. This name can be used to identify issues based on the ProviderType property.
EsLintJsonFormat
Alias from Cake.Issues.EsLint addin
Gets an instance for the ESLint JSON log format as written by the JSON formatter.

Cake.Issues.GitRepository addin

Contains functionality related to analyze Git repositories.

Issue Providers

GitRepositoryIssues(GitRepositoryIssuesSettings)
Alias from Cake.Issues.GitRepository addin
Gets an instance of a provider for analyzing a Git repository and reporting issues using specified settings.
GitRepositoryIssuesProviderTypeName
Alias from Cake.Issues.GitRepository addin
Gets the name of the Git repository issue provider. This name can be used to identify issues based on the ProviderType property.

Cake.Issues.InspectCode addin

Contains functionality for reading issues from JetBrains Inspect Code log files.

Issue Providers

InspectCodeIssues(InspectCodeIssuesSettings)
Alias from Cake.Issues.InspectCode addin
Gets an instance of a provider for issues reported by JetBrains Inspect Code using specified settings.
InspectCodeIssuesFromContent(string)
Alias from Cake.Issues.InspectCode addin
Gets an instance of a provider for issues reported by JetBrains Inspect Code using log file content.
InspectCodeIssuesFromFilePath(FilePath)
Alias from Cake.Issues.InspectCode addin
Gets an instance of a provider for issues reported by JetBrains Inspect Code using a log file from disk.
InspectCodeIssuesProviderTypeName
Alias from Cake.Issues.InspectCode addin
Gets the name of the Inspect Code issue provider. This name can be used to identify issues based on the ProviderType property.

Cake.Issues.Markdownlint addin

Contains functionality for reading issues from Markdownlint log files. Provider for issues reported my markdownlint-cli. Provider for issues reported my Markdownlint.

Issue Providers

MarkdownlintAddRuleUrlResolver(Func<MarkdownlintRuleDescription, Uri>)
Alias from Cake.Issues.Markdownlint addin
Registers a new URL resolver with default priority of 0.
MarkdownlintAddRuleUrlResolver(Func<MarkdownlintRuleDescription, Uri>, int)
Alias from Cake.Issues.Markdownlint addin
Registers a new URL resolver with a specific priority.
MarkdownlintCliLogFileFormat
Alias from Cake.Issues.Markdownlint addin
Gets an instance for the log format as written by markdownlint-cli or Cake.Markdownlint.
MarkdownlintIssues(MarkdownlintIssuesSettings)
Alias from Cake.Issues.Markdownlint addin
Gets an instance of a provider for issues reported by Markdownlint using specified settings.
MarkdownlintIssuesFromContent(string, BaseMarkdownlintLogFileFormat)
Alias from Cake.Issues.Markdownlint addin
Gets an instance of a provider for issues reported by Markdownlint using log file content.
MarkdownlintIssuesFromFilePath(FilePath, BaseMarkdownlintLogFileFormat)
Alias from Cake.Issues.Markdownlint addin
Gets an instance of a provider for issues reported by Markdownlint using a log file from disk.
MarkdownlintIssuesProviderTypeName
Alias from Cake.Issues.Markdownlint addin
Gets the name of the Markdownlint issue provider. This name can be used to identify issues based on the ProviderType property.
MarkdownlintV1LogFileFormat
Alias from Cake.Issues.Markdownlint addin
Gets an instance for the log format as written by Markdownlint with options.resultVersion set to 1.

Cake.Issues.MsBuild addin

Contains functionality for reading warnings from MSBuild log files.

Issue Providers

MsBuildAddRuleUrlResolver(Func<MsBuildRuleDescription, Uri>)
Alias from Cake.Issues.MsBuild addin
Registers a new URL resolver with default priority of 0.
MsBuildAddRuleUrlResolver(Func<MsBuildRuleDescription, Uri>, int)
Alias from Cake.Issues.MsBuild addin
Registers a new URL resolver with a specific priority.
MsBuildBinaryLogFileFormat
Alias from Cake.Issues.MsBuild addin
Gets an instance for the MsBuild binary log format.
MsBuildIssues(MsBuildIssuesSettings)
Alias from Cake.Issues.MsBuild addin
Gets an instance of a provider for issues reported as MsBuild warnings using specified settings.
MsBuildIssuesFromContent(string, BaseMsBuildLogFileFormat)
Alias from Cake.Issues.MsBuild addin
Gets an instance of a provider for issues reported as MsBuild warnings using log content.
MsBuildIssuesFromFilePath(FilePath, BaseMsBuildLogFileFormat)
Alias from Cake.Issues.MsBuild addin
Gets an instance of a provider for issues reported as MsBuild warnings using a log file from disk.
MsBuildIssuesProviderTypeName
Alias from Cake.Issues.MsBuild addin
Gets the name of the MsBuild issue provider. This name can be used to identify issues based on the ProviderType property.
MsBuildXmlFileLoggerFormat
Alias from Cake.Issues.MsBuild addin

Gets an instance for the MsBuild log format as written by the XmlFileLogger class from MSBuild Extension Pack.

You can add the logger to the MSBuildSettings like this:

var settings = new MSBuildSettings()
    .WithLogger(
        Context.Tools.Resolve("MSBuild.ExtensionPack.Loggers.dll").FullPath,
        "XmlFileLogger",
        string.Format(
            "logfile=\"{0}\";verbosity=Detailed;encoding=UTF-8",
            @"c:\build\msbuild.log")
    );

In order to use the above logger, include the following in your build.cake file to download and install from NuGet.org:

#tool "nuget:?package=MSBuild.Extension.Pack"

Cake.Issues.PullRequests.AppVeyor addin

Contains functionality related to writing code analysis issues to AppVeyor builds.

Pull Request Systems

AppVeyorBuilds()
Alias from Cake.Issues.PullRequests.AppVeyor addin
Gets an object for writing issues to AppVeyor builds using the default settings.
AppVeyorBuilds(AppVeyorBuildSettings)
Alias from Cake.Issues.PullRequests.AppVeyor addin
Gets an object for writing issues to AppVeyor builds using the specified settings.

Cake.Issues.PullRequests.AzureDevOps addin

Contains functionality related to writing code analysis issues to Azure DevOps pull requests.

Pull Request Systems

AzureDevOpsPullRequests()
Alias from Cake.Issues.PullRequests.AzureDevOps addin
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.
AzureDevOpsPullRequests(AzureDevOpsPullRequestSystemSettings)
Alias from Cake.Issues.PullRequests.AzureDevOps addin
Gets an object for writing issues to Azure DevOps pull request using the specified settings.
AzureDevOpsPullRequests(IAzureDevOpsCredentials)
Alias from Cake.Issues.PullRequests.AzureDevOps addin
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.
AzureDevOpsPullRequests(Uri, int, IAzureDevOpsCredentials)
Alias from Cake.Issues.PullRequests.AzureDevOps addin
Gets an object for writing issues to Azure DevOps pull request in a specific repository and with a specific ID.
AzureDevOpsPullRequests(Uri, string, IAzureDevOpsCredentials)
Alias from Cake.Issues.PullRequests.AzureDevOps addin
Gets an object for writing issues to Azure DevOps pull request in a specific repository and for a specific source branch.

Cake.Issues.PullRequests addin

Contains functionality related to reporting issues to pull requests.

Reporting Issues To Pull Requests

Cake.Issues.PullRequests.GitHubActions addin

Contains functionality related to writing code analysis issues to GitHub Actions.

Pull Request Systems

GitHubActionsBuilds()
Alias from Cake.Issues.PullRequests.GitHubActions addin
Gets an object for writing issues to GitHub Actions using the default settings.
GitHubActionsBuilds(GitHubActionsBuildSettings)
Alias from Cake.Issues.PullRequests.GitHubActions addin
Gets an object for writing issues to GitHub Actions using the specified settings.

Cake.Issues.Reporting addin

Contains functionality related to creating issue reports.

Creating Issue Reports

CreateIssueReport(IEnumerable<IIssue>, IIssueReportFormat, DirectoryPath, FilePath)
Alias from Cake.Issues.Reporting addin
Creates a report for a list of issues in the specified format.
CreateIssueReport(IEnumerable<IIssue>, IIssueReportFormat, ICreateIssueReportSettings)
Alias from Cake.Issues.Reporting addin
Creates a report for a list of issues with the specific settings.
CreateIssueReport(IEnumerable<IIssueProvider>, IIssueReportFormat, DirectoryPath, FilePath)
Alias from Cake.Issues.Reporting addin
Creates a report for a list of issues in the specified format.
CreateIssueReport(IEnumerable<IIssueProvider>, IIssueReportFormat, ICreateIssueReportFromIssueProviderSettings)
Alias from Cake.Issues.Reporting addin
Creates a report for a list of issues with the specific settings.
CreateIssueReport(IIssueProvider, IIssueReportFormat, DirectoryPath, FilePath)
Alias from Cake.Issues.Reporting addin
Creates a report for a the issues from an issue provider in the specified format.
CreateIssueReport(IIssueProvider, IIssueReportFormat, ICreateIssueReportFromIssueProviderSettings)
Alias from Cake.Issues.Reporting addin
Creates a report for a the issues from an issue provider with the specific settings.

Cake.Issues.Reporting.Generic addin

Contains functionality for creating issue reports in any text based format (HTML, Markdown, ...).

Reporting Formats

GenericIssueReportFormat(GenericIssueReportFormatSettings)
Alias from Cake.Issues.Reporting.Generic addin
Gets an instance of a the generic report format using specified settings.
GenericIssueReportFormatFromContent(string)
Alias from Cake.Issues.Reporting.Generic addin
Gets an instance of a the generic report format using a template string.
GenericIssueReportFormatFromContent(string, Action<GenericIssueReportFormatSettings>)
Alias from Cake.Issues.Reporting.Generic addin
Gets an instance of a the generic report format using a template string with custom settings.
GenericIssueReportFormatFromEmbeddedTemplate(GenericIssueReportTemplate)
Alias from Cake.Issues.Reporting.Generic addin
Gets an instance of a the generic report format using an embedded template.
GenericIssueReportFormatFromEmbeddedTemplate(GenericIssueReportTemplate, Action<GenericIssueReportFormatSettings>)
Alias from Cake.Issues.Reporting.Generic addin
Gets an instance of a the generic report format using an embedded template with custom settings.
GenericIssueReportFormatFromFilePath(FilePath)
Alias from Cake.Issues.Reporting.Generic addin
Gets an instance of a the generic report format using a local template.
GenericIssueReportFormatFromFilePath(FilePath, Action<GenericIssueReportFormatSettings>)
Alias from Cake.Issues.Reporting.Generic addin
Gets an instance of a the generic report format using a local template with custom settings.

Cake.Issues.Reporting.Sarif addin

Contains functionality to generate SARIF compatible files.

Reporting Formats

SarifIssueReportFormat()
Alias from Cake.Issues.Reporting.Sarif addin
Gets an instance of the SARIF report format using default settings.
SarifIssueReportFormat(SarifIssueReportFormatSettings)
Alias from Cake.Issues.Reporting.Sarif addin
Gets an instance of the SARIF report format using specified settings.