examples.md

Order	Title	Description
30	Examples	Examples for using the Cake.Issues.MsBuild addin.

The following example will call MsBuild to build the solution and outputs the number of warnings.

To read issues from MsBuild log files you need to import the core addin and the MsBuild support:

#addin "Cake.Issues"
#addin "Cake.Issues.MsBuild"

In this example the log file is written by the XmlFileLogger class from MSBuild Extension Pack. In order to use the above logger, the following line will download and install the tool from NuGet.org:

#tool "nuget:?package=MSBuild.Extension.Pack"

:::{.alert .alert-warning} Please note that you always should pin addins and tools to a specific version to make sure your builds are deterministic and won't break due to updates to one of the packages.

See pinning addin versions for details. :::

We need some global variables:

var logPath = @"c:\build\msbuild.log";
var repoRootPath = @"c:\repo";

The following task will build the solution and write a log file:

Task("Build-Solution").Does(() =>
{
    // Build solution.
    var settings =
        new MSBuildSettings()
            .WithLogger(
                Context.Tools.Resolve("MSBuild.ExtensionPack.Loggers.dll").FullPath,
                "XmlFileLogger",
                $"logfile=\"{logPath}\";verbosity=Detailed;encoding=UTF-8"
    );

    MSBuild(repoRootPath.CombineWithFilePath("MySolution.sln"), settings);
});

Finally you can define a task where you call the core addin with the desired issue provider. The following example reads issues reported as MsBuild warnings by the XmlFileLogger class from MSBuild Extension Pack:

Task("Read-Issues")
    .IsDependentOn("Build-Solution")
    .Does(() =>
    {
        // Read Issues.
        var issues =
            ReadIssues(
                MsBuildIssuesFromFilePath(
                    logPath,
                    MsBuildXmlFileLoggerFormat),
                repoRootFolder);

        Information("{0} issues are found.", issues.Count());
    });