Features

The Cake.Issues.MsBuild addin provides the following features.

Tip: Running MSBuild

MSBuild can be run using the DotNet aliases or MsBuild aliases.

Basic features

• Reads errors and warnings from MSBuild log files.
• Provides URLs .NET SDK analyzers code quality rules (CA*), .NET SDK analyzers code style rules (IDE*), StyleCop analyzer rules (SA*), SonarLint rules (S*) and Roslynator rules (RCS*).
• Support for custom URL resolving using the MsBuildAddRuleUrlResolver alias.

Supported log file formats

• MsBuildBinaryLogFileFormat alias for reading issues from binary log files.
• MsBuildXmlFileLoggerFormat alias for reading issues from log files created by MSBuild Extension Pack XmlFileLogger.

Supported IIssue properties

MsBuildBinaryLogFileFormatMsBuildXmlFileLoggerFormat

• IIssue.ProviderType
• IIssue.ProviderName
• IIssue.Run (1)
• IIssue.Identifier (2)
• IIssue.ProjectName
• IIssue.ProjectFileRelativePath
• IIssue.AffectedFileRelativePath
• IIssue.Line
• IIssue.EndLine
• IIssue.Column
• IIssue.EndColumn
• IIssue.FileLink (3)
• IIssue.MessageText
• IIssue.MessageHtml
• IIssue.MessageMarkdown
• IIssue.Priority
• IIssue.PriorityName
• IIssue.RuleId
• IIssue.RuleUrl (4)

1. Can be set while reading issues
2. Set to IIssue.MessageText
3. Can be set while reading issues
4. For .NET SDK analyzers (CA*), StyleCop analyzer rules (SA*), SonarLint rules (S*) and Roslynator rules (RCS*). Support for additional rules can be added through a custom MsBuildAddRuleUrlResolver

• IIssue.ProviderType
• IIssue.ProviderName
• IIssue.Run (1)
• IIssue.Identifier (2)
• IIssue.ProjectName
• IIssue.ProjectFileRelativePath
• IIssue.AffectedFileRelativePath
• IIssue.Line
• IIssue.EndLine
• IIssue.Column
• IIssue.EndColumn
• IIssue.FileLink (3)
• IIssue.MessageText
• IIssue.MessageHtml
• IIssue.MessageMarkdown
• IIssue.Priority
• IIssue.PriorityName
• IIssue.RuleId
• IIssue.RuleUrl (4)

1. Can be set while reading issues
2. Set to IIssue.MessageText
3. Can be set while reading issues
4. For .NET SDK analyzers code quality rules (CA*), .NET SDK analyzers code style rules (IDE*), StyleCop analyzer rules (SA*), SonarLint rules (S*) and Roslynator rules (RCS*). Support for additional rules can be added through a custom MsBuildAddRuleUrlResolver