Skip to content

Commit 36e7d7f

Browse files
pascalbergerpascalberger
committed
Merge tag '5.2.0' into develop
2 parents 331cc98 + ac987dc commit 36e7d7f

39 files changed

+165
-37
lines changed

‎docs/input/documentation/recipe/configuration.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,3 +153,24 @@ By default [Cake.Git addin](https://cakebuild.net/extensions/cake-git/){target="
153153
| `IssueFilters` | Empty | List of filter functions which should be applied before posting issues to pull requests. |
154154
| `ShouldSetPullRequestStatus` | `true` | Indicates whether a status on the pull request should be set if there are any issues found. |
155155
| `ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun` | `true` | Indicates whether a separate status should be set for issues of every issue provider and run. |
156+
157+
## Build breaking
158+
159+
=== "Cake.Issues.Recipe"
160+
161+
| IssuesParameters.BuildBreaking Property | Default Value | Description |
162+
|-----------------------------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------|
163+
| `ShouldFailBuildOnIssues` | `false` | Indicates whether build should fail if any issues are found. |
164+
| `MinimumPriority` | `IssuePriority.Undefined` | The minimum priority of issues considered to fail the build. If set to `IssuePriority.Undefined`, all issues are considered. |
165+
| `IssueProvidersToConsider` | `[]` | List of issue provider types to consider. |
166+
| `IssueProvidersToIgnore` | `[]` | List of issue provider types to ignore. |
167+
168+
=== "Cake.Frosting.Issues.Recipe"
169+
170+
| IssuesContext.Parameters.BuildBreaking Property | Default Value | Description |
171+
|-------------------------------------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------|
172+
| `ShouldFailBuildOnIssues` | `false` | Indicates whether build should fail if any issues are found. |
173+
| `MinimumPriority` | `IssuePriority.Undefined` | The minimum priority of issues considered to fail the build. If set to `IssuePriority.Undefined`, all issues are considered. |
174+
| `IssueProvidersToConsider` | `[]` | List of issue provider types to consider. |
175+
| `IssueProvidersToIgnore` | `[]` | List of issue provider types to ignore. |
176+

‎docs/input/news/posts/2025-01-09-cake-issues-v5.2.0-released.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
title: Cake Issues v5.2.0 Released
3+
date: 2025-01-09
4+
categories:
5+
- Release Notes
6+
search:
7+
boost: 0.5
8+
---
9+
10+
Cake Issues version 5.2.0 has been released bringing improvements to build breaking and SARIF issue provider.
11+
12+
<!-- more -->
13+
14+
This post shows the highlights included in this release.
15+
For update instructions skip to [Updating from previous versions](#updating-from-previous-versions).
16+
17+
❤ Huge thanks to our community! This release would not have been possible without your support and contributions! ❤
18+
19+
People working on this release:
20+
21+
* [eoehen](https://github.com/eoehen){target="_blank"}
22+
* [pascalberger](https://github.com/pascalberger){target="_blank"}
23+
24+
## Support for suppressed issues in SARIF files.
25+
26+
SARIF supports [suppressions]{target="_blank"} for issues which are suppressed, either in the source code or through some external tool.
27+
28+
Until now this property was ignored.
29+
Starting with Cake Issues 5.2.0 issues which are marked as suppressed in a SARIF file will no longer be imported by default.
30+
There is a new setting `IgnoreSuppressedIssues` which can be disabled to continue reading suppressed issues.
31+
32+
## Additional alias for build breaking
33+
34+
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
35+
the already existing [aliases for failing builds]{target="_blank"}.
36+
37+
The following example fails build if issues with severity warning or higher from MsBuild are found:
38+
39+
=== "Cake .NET Tool"
40+
41+
```csharp
42+
BreakBuildOnIssues(
43+
issues,
44+
new BuildBreakingSettings
45+
{
46+
MinimumPriority = IssuePriority.Warning,
47+
IssueProvidersToConsider = [MsBuildIssuesProviderTypeName]
48+
});
49+
```
50+
51+
=== "Cake Frosting"
52+
53+
```csharp
54+
context.BreakBuildOnIssues(
55+
issues,
56+
new BuildBreakingSettings
57+
{
58+
MinimumPriority = IssuePriority.Warning,
59+
IssueProvidersToConsider = [context.MsBuildIssuesProviderTypeName()]
60+
});
61+
```
62+
63+
The following example fails build if issues with severity warning or higher are found, ignoring issues reported by MsBuild:
64+
65+
=== "Cake .NET Tool"
66+
67+
```csharp
68+
BreakBuildOnIssues(
69+
issues,
70+
new BuildBreakingSettings
71+
{
72+
MinimumPriority = IssuePriority.Warning,
73+
IssueProvidersToIgnore = [MsBuildIssuesProviderTypeName]
74+
});
75+
```
76+
77+
=== "Cake Frosting"
78+
79+
```csharp
80+
context.BreakBuildOnIssues(
81+
issues,
82+
new BuildBreakingSettings
83+
{
84+
MinimumPriority = IssuePriority.Warning,
85+
IssueProvidersToIgnore = [context.MsBuildIssuesProviderTypeName()]
86+
});
87+
```
88+
89+
## Support for failing builds in Cake Issues Recipe
90+
91+
Cake Issues Recipe has new configuration options to support failing of builds if any issues are found:
92+
93+
- `ShouldFailBuildOnIssues`: Indicates whether build should fail if any issues are found
94+
- `MinimumPriority`: Minimum priority of issues considered to fail the build
95+
- `IssueProvidersToConsider`: List of issue provider types to consider
96+
- `IssueProvidersToIgnore`: List of issue provider types to ignore
97+
98+
## Updating from previous versions
99+
100+
Cake.Issues 5.2.0 addins are compatible with any 5.x addins.
101+
To update to the new version bump the version of the specific addins.
102+
103+
For details see [release notes](https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0){target="_blank"}
104+
105+
[suppressions]: https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#_Toc141790911
106+
[aliases for failing builds]: https://cakebuild.net/extensions/cake-issues/#Build-Breaking
107+
[Cake Issues Recipe]: ../../documentation/recipe/index.md

‎docs/mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ extra:
116116
# renovate: datasource=nuget depName=Cake.DocFx versioning=loose
117117
cake_docfx_version: 1.0.0
118118
# renovate: datasource=nuget depName=Cake.Issues versioning=loose
119-
cake_issues_version: 5.1.1
119+
cake_issues_version: 5.2.0
120120
# renovate: datasource=nuget depName=Cake.Markdownlint versioning=loose
121121
cake_markdownlint_version: 4.0.0
122122
# renovate: datasource=nuget depName=Cake.Git versioning=loose

‎nuspec/nuget/Cake.Frosting.Issues.DocFx.nuspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.DocFx.
2929
<copyright>Copyright © Cake Issues contributors</copyright>
3030
<tags>cake cake-addin cake-issues cake-issueprovider linting docfx</tags>
3131
<readme>docs\README.md</readme>
32-
<releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
32+
<releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
3333
<dependencies>
3434
<group targetFramework="net8.0">
3535
<dependency id="Cake.Core" version="5.0" exclude="Build,Analyzers" />

‎nuspec/nuget/Cake.Frosting.Issues.EsLint.nuspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.EsLint.
2929
<copyright>Copyright © Cake Issues contributors</copyright>
3030
<tags>cake cake-addin cake-issues cake-issueprovider code-analysis javascript linting eslint</tags>
3131
<readme>docs\README.md</readme>
32-
<releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
32+
<releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
3333
<dependencies>
3434
<group targetFramework="net8.0">
3535
<dependency id="Cake.Core" version="5.0" exclude="Build,Analyzers" />

‎nuspec/nuget/Cake.Frosting.Issues.GitRepository.nuspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.GitRepository.
2929
<copyright>Copyright © Cake Issues contributors</copyright>
3030
<tags>cake cake-addin cake-issues cake-issueprovider code-analysis linting git</tags>
3131
<readme>docs\README.md</readme>
32-
<releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
32+
<releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
3333
<dependencies>
3434
<group targetFramework="net8.0">
3535
<dependency id="Cake.Core" version="5.0" exclude="Build,Analyzers" />

‎nuspec/nuget/Cake.Frosting.Issues.InspectCode.nuspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.InspectCode.
2929
<copyright>Copyright © Cake Issues contributors</copyright>
3030
<tags>cake cake-addin cake-issues cake-issueprovider codeanalysis linting inspectcode</tags>
3131
<readme>docs\README.md</readme>
32-
<releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
32+
<releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
3333
<dependencies>
3434
<group targetFramework="net8.0">
3535
<dependency id="Cake.Core" version="5.0" exclude="Build,Analyzers" />

‎nuspec/nuget/Cake.Frosting.Issues.Markdownlint.nuspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.Markdownlint.
2929
<copyright>Copyright © Cake Issues contributors</copyright>
3030
<tags>cake cake-addin cake-issues cake-issueprovider linting markdown markdownlint</tags>
3131
<readme>docs\README.md</readme>
32-
<releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
32+
<releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
3333
<dependencies>
3434
<group targetFramework="net8.0">
3535
<dependency id="Cake.Core" version="5.0" exclude="Build,Analyzers" />

‎nuspec/nuget/Cake.Frosting.Issues.MsBuild.nuspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.MsBuild.
3030
<copyright>Copyright © Cake Issues contributors</copyright>
3131
<tags>cake cake-addin cake-issues cake-issueprovider code-analysis linting msbuild</tags>
3232
<readme>docs\README.md</readme>
33-
<releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
33+
<releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
3434
<dependencies>
3535
<group targetFramework="net8.0">
3636
<dependency id="Cake.Core" version="5.0" exclude="Build,Analyzers" />

‎nuspec/nuget/Cake.Frosting.Issues.PullRequests.AppVeyor.nuspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.PullRequests.AppVe
2727
<copyright>Copyright © Cake Issues contributors</copyright>
2828
<tags>cake cake-addin cake-issues cake-pullrequestsystem issues pullrequest buildserver appveyor</tags>
2929
<readme>docs\README.md</readme>
30-
<releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
30+
<releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
3131
<dependencies>
3232
<group targetFramework="net8.0">
3333
<dependency id="Cake.Common" version="5.0" exclude="Build,Analyzers" />

0 commit comments

Comments
 (0)