PrcaAliases.

ReadIssues(ICakeContext, ICodeAnalysisProvider, ReadIssuesSettings) Method

Summary

Reads issues from a single issue provider using the specified settings.
Assembly
Cake.Prca.dll
Namespace
Cake.Prca
Containing Type
PrcaAliases

Syntax

public static IEnumerable<ICodeAnalysisIssue> ReadIssues(this ICakeContext context, ICodeAnalysisProvider issueProvider, ReadIssuesSettings settings)

Examples

Read issues reported as MsBuild warnings and format comments in Markdown:

 var settings =
         new ReadIssuesSettings(new DirectoryPath("c:\repo"))
         {
             Format = PrcaCommentFormat.Markdown
         };

     ReportIssuesToPullRequest(
         MsBuildCodeAnalysisFromFilePath(
             @"C:\build\msbuild.log",
             MsBuildXmlFileLoggerFormat),
         settings));

Attributes

Type Description
CakeMethodAliasAttribute

Parameters

Name Type Description
context ICakeContext The context.
issueProvider ICodeAnalysisProvider The provider for issues.
settings ReadIssuesSettings The settings.

Return Value

Type Description
IEnumerable<T> Issues reported by issue provider.
GitHub