Basic usage

To create report for issues you need to import the following core addins:

#addin "Cake.Issues"
#addin "Cake.Issues.Reporting"

Also you need to import at least one issue provider and report format. In the following example the issue provider for reading warnings from MsBuild log files and generic report format is imported:

#addin "Cake.Issues.MsBuild"
#addin "Cake.Issues.Reporting.Generic"

Please note that you always should pin addins to a specific version to make sure your builds are deterministic and won't break due to updates to one of the addins.

See pinning addin versions for details.

Finally you can define a task where you call the reporting addin with the desired issue provider and report format:

Task("Create-Report").Does(() =>
{
    var repoRootFolder = new DirectoryPath(@"C:\repo");
    CreateIssueReport(
        MsBuildIssuesFromFilePath(
            @"C:\build\msbuild.log",
            MsBuildXmlFileLoggerFormat),
        GenericIssueReportFormatFromEmbeddedTemplate(GenericIssueReportTemplate.HtmlDiagnostic),
        repoRootFolder,
        @"c:\report.html");
});
GitHub