Issues

Summary

Contains functionality for reading warnings from MSBuild log files.

Creating Issue Reports

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

Creating Issues

NewIssue(ICakeContext, string, string, string) Initiates the creation of a new IIssue.
Addin from Cake.Issues.dll

Issue Providers

DocFxIssues(ICakeContext, DocFxIssuesSettings) Gets an instance of a provider for warnings reported by DocFx using specified settings.
Addin from Cake.Issues.DocFx.dll
DocFxIssuesFromContent(ICakeContext, string) 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.Issues.DocFx.dll
DocFxIssuesFromContent(ICakeContext, string, DirectoryPath) Gets an instance of a provider for warnings reported by DocFx using log file content.
Addin from Cake.Issues.DocFx.dll
DocFxIssuesFromFilePath(ICakeContext, FilePath) 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.Issues.DocFx.dll
DocFxIssuesFromFilePath(ICakeContext, FilePath, DirectoryPath) Gets an instance of a provider for warnings reported by DocFx using a log file from disk.
Addin from Cake.Issues.DocFx.dll
DocFxIssuesProviderTypeName Gets the name of the DocFx issue provider. This name can be used to identify issues based on the ProviderType property.
Addin from Cake.Issues.DocFx.dll
EsLintAddRuleUrlResolver(ICakeContext, Func<BaseRuleDescription, Uri>) Registers a new URL resolver with default priority of 0.
Addin from Cake.Issues.EsLint.dll
EsLintAddRuleUrlResolver(ICakeContext, Func<BaseRuleDescription, Uri>, int) Registers a new URL resolver with a specific priority.
Addin from Cake.Issues.EsLint.dll
EsLintIssues(ICakeContext, EsLintIssuesSettings) Gets an instance of a provider for issues reported by ESLint using specified settings.
Addin from Cake.Issues.EsLint.dll
EsLintIssuesFromContent(ICakeContext, string, BaseEsLintLogFileFormat) Gets an instance of a provider for issues reported by ESLint using log file content.
Addin from Cake.Issues.EsLint.dll
EsLintIssuesFromFilePath(ICakeContext, FilePath, BaseEsLintLogFileFormat) Gets an instance of a provider for issues reported by ESLint using a log file from disk.
Addin from Cake.Issues.EsLint.dll
EsLintIssuesProviderTypeName Gets the name of the ESLint issue provider. This name can be used to identify issues based on the ProviderType property.
Addin from Cake.Issues.EsLint.dll
EsLintJsonFormat Gets an instance for the ESLint JSON log format as written by the JSON formatter.
Addin from Cake.Issues.EsLint.dll
InspectCodeIssues(ICakeContext, InspectCodeIssuesSettings) Gets an instance of a provider for issues reported by JetBrains Inspect Code using specified settings.
Addin from Cake.Issues.InspectCode.dll
InspectCodeIssuesFromContent(ICakeContext, string) Gets an instance of a provider for issues reported by JetBrains Inspect Code using log file content.
Addin from Cake.Issues.InspectCode.dll
InspectCodeIssuesFromFilePath(ICakeContext, FilePath) Gets an instance of a provider for issues reported by JetBrains Inspect Code using a log file from disk.
Addin from Cake.Issues.InspectCode.dll
InspectCodeIssuesProviderTypeName 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.Issues.InspectCode.dll
MarkdownlintAddRuleUrlResolver(ICakeContext, Func<MarkdownlintRuleDescription, Uri>) Registers a new URL resolver with default priority of 0.
Addin from Cake.Issues.Markdownlint.dll
MarkdownlintAddRuleUrlResolver(ICakeContext, Func<MarkdownlintRuleDescription, Uri>, int) Registers a new URL resolver with a specific priority.
Addin from Cake.Issues.Markdownlint.dll
MarkdownlintCliLogFileFormat Gets an instance for the log format as written by markdownlint-cli or Cake.Markdownlint.
Addin from Cake.Issues.Markdownlint.dll
MarkdownlintIssues(ICakeContext, MarkdownlintIssuesSettings) Gets an instance of a provider for issues reported by Markdownlint using specified settings.
Addin from Cake.Issues.Markdownlint.dll
MarkdownlintIssuesFromContent(ICakeContext, string, BaseMarkdownlintLogFileFormat) Gets an instance of a provider for issues reported by Markdownlint using log file content.
Addin from Cake.Issues.Markdownlint.dll
MarkdownlintIssuesFromFilePath(ICakeContext, FilePath, BaseMarkdownlintLogFileFormat) Gets an instance of a provider for issues reported by Markdownlint using a log file from disk.
Addin from Cake.Issues.Markdownlint.dll
MarkdownlintIssuesProviderTypeName Gets the name of the Markdownlint issue provider. This name can be used to identify issues based on the ProviderType property.
Addin from Cake.Issues.Markdownlint.dll
MarkdownlintLogFileFormat Gets an instance for the log format as written by Markdownlint.
Addin from Cake.Issues.Markdownlint.dll
MsBuildAddRuleUrlResolver(ICakeContext, Func<MsBuildRuleDescription, Uri>) Registers a new URL resolver with default priority of 0.
Addin from Cake.Issues.MsBuild.dll
MsBuildAddRuleUrlResolver(ICakeContext, Func<MsBuildRuleDescription, Uri>, int) Registers a new URL resolver with a specific priority.
Addin from Cake.Issues.MsBuild.dll
MsBuildIssues(ICakeContext, MsBuildIssuesSettings) Gets an instance of a provider for issues reported as MsBuild warnings using specified settings.
Addin from Cake.Issues.MsBuild.dll
MsBuildIssuesFromContent(ICakeContext, string, BaseMsBuildLogFileFormat) Gets an instance of a provider for issues reported as MsBuild warnings using log content.
Addin from Cake.Issues.MsBuild.dll
MsBuildIssuesFromFilePath(ICakeContext, FilePath, BaseMsBuildLogFileFormat) Gets an instance of a provider for issues reported as MsBuild warnings using a log file from disk.
Addin from Cake.Issues.MsBuild.dll
MsBuildIssuesProviderTypeName Gets the name of the MsBuild issue provider. This name can be used to identify issues based on the ProviderType property.
Addin from Cake.Issues.MsBuild.dll

Pull Request Systems

AppVeyorBuilds(ICakeContext) Gets an object for writing issues to AppVeyor builds using the default settings.
Addin from Cake.Issues.PullRequests.AppVeyor.dll
AppVeyorBuilds(ICakeContext, AppVeyorBuildSettings) Gets an object for writing issues to AppVeyor builds using the specified settings.
Addin from Cake.Issues.PullRequests.AppVeyor.dll
TfsPullRequests(ICakeContext, TfsPullRequestSystemSettings) Gets an object for writing issues to Team Foundation Server or Visual Studio Team Services pull request using the specified settings.
Addin from Cake.Issues.PullRequests.Tfs.dll
TfsPullRequests(ICakeContext, Uri, int, ITfsCredentials) 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.Issues.PullRequests.Tfs.dll
TfsPullRequests(ICakeContext, Uri, string, ITfsCredentials) 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.Issues.PullRequests.Tfs.dll

Reading Issues

ReadIssues(ICakeContext, IEnumerable<IIssueProvider>, DirectoryPath) Reads issues from issue providers.
Addin from Cake.Issues.dll
ReadIssues(ICakeContext, IEnumerable<IIssueProvider>, ReadIssuesSettings) Reads issues from issue providers using the specified settings.
Addin from Cake.Issues.dll
ReadIssues(ICakeContext, IIssueProvider, DirectoryPath) Reads issues from a single issue provider.
Addin from Cake.Issues.dll
ReadIssues(ICakeContext, IIssueProvider, ReadIssuesSettings) Reads issues from a single issue provider using the specified settings.
Addin from Cake.Issues.dll

Reporting Formats

GenericIssueReportFileLinkSettingsForGitHub(ICakeContext, Uri, string) Gets an instance of the file link settings for linking files hosted on GitHub.
Addin from Cake.Issues.Reporting.Generic.dll
GenericIssueReportFileLinkSettingsForGitHub(ICakeContext, Uri, string, string) Gets an instance of the file link settings for linking files hosted on GitHub in a sub-folder.
Addin from Cake.Issues.Reporting.Generic.dll
GenericIssueReportFileLinkSettingsForTeamFoundationServer(ICakeContext, Uri, string) Gets an instance of the file link settings for linking to files hosted in Visual Studio Team Service or Team Foundation Server.
Addin from Cake.Issues.Reporting.Generic.dll
GenericIssueReportFileLinkSettingsForTeamFoundationServer(ICakeContext, Uri, string, string) Gets an instance of the file link settings for linking to files hosted in Visual Studio Team Service or Team Foundation Server in a sub-folder.
Addin from Cake.Issues.Reporting.Generic.dll
GenericIssueReportFormat(ICakeContext, GenericIssueReportFormatSettings) Gets an instance of a the generic report format using specified settings.
Addin from Cake.Issues.Reporting.Generic.dll
GenericIssueReportFormatFromContent(ICakeContext, string) Gets an instance of a the generic report format using a template string.
Addin from Cake.Issues.Reporting.Generic.dll
GenericIssueReportFormatFromContent(ICakeContext, string, Action<GenericIssueReportFormatSettings>) Gets an instance of a the generic report format using a template string with custom settings.
Addin from Cake.Issues.Reporting.Generic.dll
GenericIssueReportFormatFromEmbeddedTemplate(ICakeContext, GenericIssueReportTemplate) Gets an instance of a the generic report format using an embedded template.
Addin from Cake.Issues.Reporting.Generic.dll
GenericIssueReportFormatFromEmbeddedTemplate(ICakeContext, GenericIssueReportTemplate, Action<GenericIssueReportFormatSettings>) Gets an instance of a the generic report format using an embedded template with custom settings.
Addin from Cake.Issues.Reporting.Generic.dll
GenericIssueReportFormatFromFilePath(ICakeContext, FilePath) Gets an instance of a the generic report format using a local template.
Addin from Cake.Issues.Reporting.Generic.dll
GenericIssueReportFormatFromFilePath(ICakeContext, FilePath, Action<GenericIssueReportFormatSettings>) Gets an instance of a the generic report format using a local template with custom settings.
Addin from Cake.Issues.Reporting.Generic.dll

Reporting Issues To Pull Requests