Skip to content

Commit e2dba1f

Browse files
committed
Add news entry
1 parent 689e9d5 commit e2dba1f

File tree

1 file changed

+99
-0
lines changed

1 file changed

+99
-0
lines changed
Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
title: Cake Issues v5.4.0 Released
3+
date: 2025-01-16
4+
categories:
5+
- Release Notes
6+
search:
7+
boost: 0.5
8+
---
9+
10+
Cake Issues version 5.4.0 has been released bringing improvements for build breaking and multiple issue providers.
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+
* [pascalberger](https://github.com/pascalberger){target="_blank"}
22+
23+
## Improvements for build breaking
24+
25+
This version adds additional overloads to the [build breaking aliases]{target="_blank"} to support passing
26+
in an action which is called before the build is failed.
27+
28+
The following example fails the build if issues with severity warning or higher are found, ignoring MsBuild issues.
29+
In case of the build failing the number of issues is printed:
30+
31+
=== "Cake .NET Tool"
32+
33+
```csharp
34+
BreakBuildOnIssues(
35+
issues,
36+
new BuildBreakingSettings
37+
{
38+
MinimumPriority = IssuePriority.Warning
39+
IssueProvidersToIgnore = [MsBuildIssuesProviderTypeName]
40+
},
41+
x => Error(
42+
"{0} issues with severity warning or higher are found",
43+
x.Count()));
44+
```
45+
46+
=== "Cake Frosting"
47+
48+
```csharp
49+
context.BreakBuildOnIssues(
50+
issues,
51+
new BuildBreakingSettings
52+
{
53+
MinimumPriority = IssuePriority.Warning
54+
IssueProvidersToIgnore = [context.MsBuildIssuesProviderTypeName()]
55+
},
56+
x => context.Error(
57+
"{0} issues with severity warning or higher are found",
58+
x.Count()));
59+
```
60+
61+
## Improvements for MsBuild issue provider
62+
63+
Improvements have been made for providing rule URLs for issues reported by the MsBuild issue provider:
64+
65+
* For NET SDK analyzers code style rules (`IDE*`) URLs will be provided.
66+
* .NET SDK analyzers code quality rules (`CA*`) will link directly to the rule page instead of starting a Google search
67+
68+
There is also a new [example for using custom URL resolver].
69+
70+
## Improvements for SARIF issue provider
71+
72+
The SARIF issue provider has been improved to also support files which use absolute paths for results.
73+
74+
## Improvements for Test Anything Protocol issue provider
75+
76+
Rule URL resolving has been implemented in the Test Anything Provider for the following log formats:
77+
78+
* `StylelintLogFileFormat` for [rules shipped with stylelint]{target="_blank"}
79+
* `TextlintLogFileFormat` for [rules shipped with Textlint]{target="_blank"}
80+
81+
Starting with this version there also new aliases for providing custom URL resolvers to support plugins or custom rules.
82+
83+
## Documentation updates
84+
85+
There is a new page describing the [process to report issues to build servers and pull requests],
86+
including the available customization options.
87+
88+
## Updating from previous versions
89+
90+
Cake.Issues 5.4.0 addins are compatible with any 5.x addins.
91+
To update to the new version bump the version of the specific addins.
92+
93+
For details see [release notes](https://github.com/cake-contrib/Cake.Issues/releases/tag/5.4.0){target="_blank"}
94+
95+
[build breaking aliases]: https://cakebuild.net/extensions/cake-issues/#Build-Breaking
96+
[process to report issues to build servers and pull requests]: ../../documentation/how-cake-issues-works/pull-request-integration.md
97+
[example for using custom URL resolver]: ../../documentation/issue-providers/msbuild/examples/use-custom-url-resolver.md
98+
[rules shipped with stylelint]: https://stylelint.io/user-guide/rules
99+
[rules shipped with Textlint]: https://github.com/textlint/textlint/wiki/Collection-of-textlint-rule#rule-list

0 commit comments

Comments
 (0)