Summary
Creates a report for a the issues from an issue provider in the specified format.
Syntax
public static FilePath CreateIssueReport(this ICakeContext context, IIssueProvider issueProvider, IIssueReportFormat reportFormat, DirectoryPath repositoryRoot, FilePath outputFilePath)
Examples
Create HTML report using the diagnostic template:
CreateIssueReport(
InspectCodeIssuesFromFilePath(
@"C:\build\inspectcode.log",
MsBuildXmlFileLoggerFormat),
GenericIssueReportFormatFromEmbeddedTemplate(GenericIssueReportTemplate.HtmlDiagnostic),
@"c:\repo",
@"c:\report.html");
Attributes
Type |
Description |
CakeMethodAliasAttribute |
|
CakeAliasCategoryAttribute |
|
Parameters
Name |
Type |
Description |
context |
ICakeContext |
The context. |
issueProvider |
IIssueProvider |
Issue provider for whose issues the report should be generated. |
reportFormat |
IIssueReportFormat |
Format in which the report should be generated. |
repositoryRoot |
DirectoryPath |
Root path of the repository. |
outputFilePath |
FilePath |
Path of the generated report file. |
Return Value
Type |
Description |
FilePath |
Path to the created report or null if report could not be created. |