This content is part of a third party extension that is not supported by the Cake project.
For more information about this extension see Cake.Issues.Reporting.
Summary
Creates a report for the issues from an issue provider in the specified format.
- Assembly
- Cake
.Issues .Reporting .dll - Namespace
- Cake
.Issues .Reporting - Containing Type
- Aliases
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 |
|---|---|
| Cake |
|
| Cake |
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. |