Aliases.

CreateIssueReport(ICakeContext, IIssueProvider, IIssueReportFormat, CreateIssueReportSettings) Method

Summary

Creates a report for a the issues from an issue provider with the specific settings.
Assembly
Cake.Issues.Reporting.dll
Namespace
Cake.Issues.Reporting
Containing Type
Aliases

Syntax

public static FilePath CreateIssueReport(this ICakeContext context, IIssueProvider issueProvider, IIssueReportFormat reportFormat, CreateIssueReportSettings settings)

Examples

Create HTML report using the diagnostic template:

 var settings =
         new CreateIssueReportSettings(@"c:\repo", @"c:\report.html");

     CreateIssueReport(
         new List<IIssueProvider>
         InspectCodeIssuesFromFilePath(
             @"C:\build\inspectcode.log",
             MsBuildXmlFileLoggerFormat),
         GenericIssueReportFormatFromEmbeddedTemplate(GenericIssueReportTemplate.HtmlDiagnostic),
         settings);

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.
settings CreateIssueReportSettings The settings.

Return Value

Type Description
FilePath Path to the created report or null if report could not be created.
GitHub