Issues

Summary

Contains functionality for reading warnings from MSBuild log files.

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, ILogFileFormat) Gets an instance of a provider for issues reported by ESLint using log file content.
Addin from Cake.Issues.EsLint.dll
EsLintIssuesFromFilePath(ICakeContext, FilePath, ILogFileFormat) 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
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) Gets an instance of a provider for issues reported by Markdownlint using log file content.
Addin from Cake.Issues.Markdownlint.dll
MarkdownlintIssuesFromFilePath(ICakeContext, FilePath) 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
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, ILogFileFormat) Gets an instance of a provider for issues reported as MsBuild warnings using log content.
Addin from Cake.Issues.MsBuild.dll
MsBuildIssuesFromFilePath(ICakeContext, FilePath, ILogFileFormat) 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
MsBuildXmlFileLoggerFormat

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"


Addin from Cake.Issues.MsBuild.dll

Pull Request Systems

TfsAuthenticationAzureActiveDirectory(ICakeContext, string, string) Returns credentials for authentication with an Azure Active Directory.
Addin from Cake.Issues.PullRequests.Tfs.dll
TfsAuthenticationBasic(ICakeContext, string, string) 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.Issues.PullRequests.Tfs.dll
TfsAuthenticationNtlm(ICakeContext) Returns credentials for integrated / NTLM authentication. Can only be used for on-premise Team Foundation Server.
Addin from Cake.Issues.PullRequests.Tfs.dll
TfsAuthenticationOAuth(ICakeContext, string) Returns credentials for OAuth authentication. Can only be used with Visual Studio Team Services.
Addin from Cake.Issues.PullRequests.Tfs.dll
TfsAuthenticationPersonalAccessToken(ICakeContext, string) Returns credentials for authentication with a personal access token. Can be used for Team Foundation Server and Visual Studio Team Services.
Addin from Cake.Issues.PullRequests.Tfs.dll
TfsPullRequests(ICakeContext, TfsPullRequestSettings) 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
TfsVotePullRequest(ICakeContext, TfsPullRequestSettings, TfsPullRequestVote) Votes for the Team Foundation Server or Visual Studio Team Services pull request using the specified settings.
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 Issues To Pull Requests