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.Sarif.

Summary

Gets an instance of the SARIF report format using specified settings.

Assembly: Cake.Issues.Reporting.Sarif.dll
Namespace: Cake.Issues.Reporting.Sarif
Containing Type: SarifIssueReportFormatAliases

Syntax

public static IIssueReportFormat SarifIssueReportFormat(this ICakeContext context, SarifIssueReportFormatSettings settings)

Examples

Create SARIF compatible file:

 var settings =
         new SarifIssueReportFormatSettings();

     CreateIssueReport(
         issues,
         SarifIssueReportFormat(settings),
         @"c:\repo",
         @"c:\export.sarif");

Attributes

Type	Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name	Type	Description
context	ICakeContext	The context.
settings	SarifIssueReportFormatSettings	Settings for generating the report.

Return Value

Type	Description
IIssueReportFormat	Instance of a SARIF report format.