GenericIssueReportFormatAliases.

GenericIssueReportFormatFromFilePath(ICakeContext, FilePath, Action<GenericIssueReportFormatSettings>) Method

Summary

Gets an instance of a the generic report format using a local template with custom settings.

Syntax

public static IIssueReportFormat GenericIssueReportFormatFromFilePath(this ICakeContext context, FilePath templatePath, Action<GenericIssueReportFormatSettings> configurator)

Examples

Create HTML report from local template file with custom title:

CreateIssueReport(
        issues,
        GenericIssueReportFormatFromFilePath(
            @"c:\ReportTemplate.cshtml",
            x => x.WithOption("Title", "My Issue Report")),
        @"c:\repo",
        @"c:\report.html");

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name Type Description
context ICakeContext The context.
templatePath FilePath Path to the template to use for generating the report.
configurator Action<GenericIssueReportFormatSettings> Action for defining the settings.

Return Value

Type Description
IIssueReportFormat Instance of a the generic report format.