Skip to content

Cake Issues v5.2.0 Released

Cake Issues version 5.2.0 has been released bringing improvements to build breaking and SARIF issue provider.

This post shows the highlights included in this release. For update instructions skip to Updating from previous versions.

❤ Huge thanks to our community! This release would not have been possible without your support and contributions! ❤

People working on this release:

Support for suppressed issues in SARIF files.

SARIF supports suppressions for issues which are suppressed, either in the source code or through some external tool.

Until now this property was ignored. Starting with Cake Issues 5.2.0 issues which are marked as suppressed in a SARIF file will no longer be imported by default. There is a new setting IgnoreSuppressedIssues which can be disabled to continue reading suppressed issues.

Additional alias for build breaking

There is a new alias for fails build if any issues are found with settings to limit to priority and issue provider types to complement the already existing aliases for failing builds.

The following example fails build if issues with severity warning or higher from MsBuild are found:

BreakBuildOnIssues(
    issues,
    new BuildBreakingSettings
    {
        MinimumPriority = IssuePriority.Warning,
        IssueProvidersToConsider = [MsBuildIssuesProviderTypeName]
    });

context.BreakBuildOnIssues(
    issues,
    new BuildBreakingSettings
    {
        MinimumPriority = IssuePriority.Warning,
        IssueProvidersToConsider = [context.MsBuildIssuesProviderTypeName()]
    });

The following example fails build if issues with severity warning or higher are found, ignoring issues reported by MsBuild:

BreakBuildOnIssues(
    issues,
    new BuildBreakingSettings
    {
        MinimumPriority = IssuePriority.Warning,
        IssueProvidersToIgnore = [MsBuildIssuesProviderTypeName]
    });

context.BreakBuildOnIssues(
    issues,
    new BuildBreakingSettings
    {
        MinimumPriority = IssuePriority.Warning,
        IssueProvidersToIgnore = [context.MsBuildIssuesProviderTypeName()]
    });

Support for failing builds in Cake Issues Recipe

Cake Issues Recipe has new configuration options to support failing of builds if any issues are found:

  • ShouldFailBuildOnIssues: Indicates whether build should fail if any issues are found
  • MinimumPriority: Minimum priority of issues considered to fail the build
  • IssueProvidersToConsider: List of issue provider types to consider
  • IssueProvidersToIgnore: List of issue provider types to ignore

Updating from previous versions

Cake.Issues 5.2.0 addins are compatible with any 5.x addins. To update to the new version bump the version of the specific addins.

For details see release notes