Merge branch 'release/5.2.0'

cake-contrib · Jan 9, 2025 · ac987dc · ac987dc
2 parents f659b5d + 878952a
commit ac987dc
Show file tree

Hide file tree

Showing 77 changed files with 1,765 additions and 744 deletions.
diff --git a/docs/input/documentation/assets/tables/supported-tools-copypaste.csv b/docs/input/documentation/assets/tables/supported-tools-copypaste.csv
@@ -0,0 +1,3 @@
+"Tool","Tool Version","Format","Issue Provider","Supported Since"
+"~~[dupFinder](https://www.jetbrains.com/help/resharper/2021.2/dupFinder.html){target='_blank'}~~{ title='Deprecated since dupFinder Command Line Tool has been sunsetted' } ",,,"Cake.Issues.DupFinder",0.8.0
+"[jscpd](https://github.com/kucherenko/jscpd){target='_blank'}",,"[jscpd-sarif-reporter](https://www.npmjs.com/package/jscpd-sarif-reporter){target='_blank'}","[Cake.Issues.Sarif](issue-providers/sarif/index.md)",4.2.0
diff --git a/docs/input/documentation/assets/tables/supported-tools-dotnet.csv b/docs/input/documentation/assets/tables/supported-tools-dotnet.csv
@@ -1,5 +1,5 @@
 "Tool","Tool Version","Format","Issue Provider","Supported Since"
-"~~[dupFinder](https://www.jetbrains.com/help/resharper/2021.2/dupFinder.html){target='_blank'}~~{ title='Deprecated since dupFinder Command Line Tool has been sunsetted' } ",,,"Cake.Issues.DupFinder",0.8.0
+"~~[dupFinder](https://www.jetbrains.com/help/resharper/2021.2/dupFinder.html){target='_blank'}~~{ title='Deprecated since dupFinder Command Line Tool has been sunsetted. See Copy/Paste Detection for alternative tools.' } ",,,"Cake.Issues.DupFinder",0.8.0
 "[InspectCode](https://www.jetbrains.com/help/resharper/InspectCode.html){target='_blank'}",,"[xml](https://www.jetbrains.com/help/resharper/InspectCode.html#alternative-output-formats){target='_blank'}","[Cake.Issues.InspectCode](issue-providers/inspectcode/index.md)",0.1.0
 "[InspectCode](https://www.jetbrains.com/help/resharper/InspectCode.html){target='_blank'}",">= 2024.1","[SARIF](https://www.jetbrains.com/help/resharper/InspectCode.html#understanding-output){target='_blank'}","[Cake.Issues.Sarif](issue-providers/sarif/index.md)",4.2.0
 "[MsBuild](https://docs.microsoft.com/visualstudio/msbuild/msbuild){target='_blank'}",,"[Binary Log 7](https://learn.microsoft.com/en-us/visualstudio/msbuild/obtaining-build-logs-with-msbuild#save-a-binary-log){target='_blank'}","[Cake.Issues.MsBuild](issue-providers/msbuild/index.md)",0.6.1

diff --git a/docs/input/documentation/issue-providers/sarif/features.md b/docs/input/documentation/issue-providers/sarif/features.md
@@ -9,6 +9,7 @@ The [Cake.Issues.Sarif addin](https://cakebuild.net/extensions/cake-issues-sarif
 ## Basic features
 
 - [x] Reads issues from files in [SARIF](https://sarifweb.azurewebsites.net/){target="_blank"} format.
+- [x] Support for reading issues reported as suppressed by the linter
 
 ## Supported IIssue properties
 

diff --git a/docs/input/documentation/recipe/configuration.md b/docs/input/documentation/recipe/configuration.md
@@ -153,3 +153,24 @@ By default [Cake.Git addin](https://cakebuild.net/extensions/cake-git/){target="
     | `IssueFilters`                                                 | Empty         | List of filter functions which should be applied before posting issues to pull requests.                                                                                                                                                 |
     | `ShouldSetPullRequestStatus`                                   | `true`        | Indicates whether a status on the pull request should be set if there are any issues found.                                                                                                                                              |
     | `ShouldSetSeparatePullRequestStatusForEachIssueProviderAndRun` | `true`        | Indicates whether a separate status should be set for issues of every issue provider and run.                                                                                                                                            |
+
+## Build breaking
+
+=== "Cake.Issues.Recipe"
+
+    | IssuesParameters.BuildBreaking Property | Default Value             | Description                                                                                                                  |
+    |-----------------------------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------|
+    | `ShouldFailBuildOnIssues`               | `false`                   | Indicates whether build should fail if any issues are found.                                                                 |
+    | `MinimumPriority`                       | `IssuePriority.Undefined` | The minimum priority of issues considered to fail the build. If set to `IssuePriority.Undefined`, all issues are considered. |
+    | `IssueProvidersToConsider`              | `[]`                      | List of issue provider types to consider.                                                                                    |
+    | `IssueProvidersToIgnore`                | `[]`                      | List of issue provider types to ignore.                                                                                      |
+
+=== "Cake.Frosting.Issues.Recipe"
+
+    | IssuesContext.Parameters.BuildBreaking Property | Default Value             | Description                                                                                                                  |
+    |-------------------------------------------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------|
+    | `ShouldFailBuildOnIssues`                       | `false`                   | Indicates whether build should fail if any issues are found.                                                                 |
+    | `MinimumPriority`                               | `IssuePriority.Undefined` | The minimum priority of issues considered to fail the build. If set to `IssuePriority.Undefined`, all issues are considered. |
+    | `IssueProvidersToConsider`                      | `[]`                      | List of issue provider types to consider.                                                                                    |
+    | `IssueProvidersToIgnore`                        | `[]`                      | List of issue provider types to ignore.                                                                                      |
+
diff --git a/docs/input/documentation/supported-tools.md b/docs/input/documentation/supported-tools.md
@@ -33,6 +33,10 @@ This pages lists tools known to be working with Cake Issues (1)
 
 {{ read_csv('assets/tables/supported-tools-clojure.csv',keep_default_na=False) }}
 
+## Copy/Paste Detection
+
+{{ read_csv('assets/tables/supported-tools-copypaste.csv',keep_default_na=False) }}
+
 ## CSS, SCSS, Sass
 
 {{ read_csv('assets/tables/supported-tools-css.csv',keep_default_na=False) }}

diff --git a/docs/input/documentation/usage/index.md b/docs/input/documentation/usage/index.md
@@ -13,10 +13,14 @@ which can be used inside your projects Cake build to add issue management.
 
 The addins can be added individually to any Cake build and allow advanced customizations:
 
-* [Creating Issues](creating-issues/creating-issues.md)
-* [Reading Issues](reading-issues/index.md)
-* [Creating Reports](creating-reports/index.md)
-* [Reporting Issues To Pull Request And Build Systems](reporting-issues-to-pull-requests/index.md)
-* [Breaking Builds](breaking-builds/breaking-builds.md)
+<div class="grid cards" markdown>
+
+* :material-creation-outline: [Creating Issues](creating-issues/creating-issues.md)
+* :material-import: [Reading Issues](reading-issues/index.md)
+* :material-monitor-dashboard: [Creating Reports](creating-reports/index.md)
+* :material-comment-text: [Reporting Issues To Pull Request And Build Systems](reporting-issues-to-pull-requests/index.md)
+* :material-exclamation: [Breaking Builds](breaking-builds/breaking-builds.md)
+
+</div>
 
 [Recipe packages]: recipe/index.md
diff --git a/docs/input/news/posts/2024-04-14-sarif-issue-provider.md b/docs/input/news/posts/2024-04-14-sarif-issue-provider.md
@@ -7,7 +7,7 @@ search:
   boost: 0.5
 ---
 
-A new [Cake.Issues.Sarif addin] has been released which adds support for reading issues in [SARIF]{target="_blank"} format.
+In [version 4.2.0] a new [Cake.Issues.Sarif addin] has been released which adds support for reading issues in [SARIF]{target="_blank"} format.
 
 <!-- more -->
 
@@ -20,6 +20,7 @@ See [Supported Tools] for an updated list of supported tools.
 The addins is available in a version for Cake .NET Tool ([Cake.Issues.Sarif]{target="_blank"})
 and Cake Frosting ([Cake.Frosting.Issues.Sarif]{target="_blank"}).
 
+[version 4.2.0]: 2024-04-14-cake-issues-v4.2.0-released.md
 [Cake.Issues.Sarif addin]: ../../documentation/issue-providers/sarif/index.md
 [SARIF]: https://sarifweb.azurewebsites.net/
 [Supported Tools]: ../../documentation/supported-tools.md

diff --git a/docs/input/news/posts/2025-01-03-tap-issue-provider.md b/docs/input/news/posts/2025-01-03-tap-issue-provider.md
@@ -7,7 +7,7 @@ search:
   boost: 0.5
 ---
 
-A new [Cake.Issues.Tap addin] has been released which adds support for reading issues in [Test Anything Protocol (TAP)]{target="_blank"} format.
+In [version 5.1.0] a new [Cake.Issues.Tap addin] has been released which adds support for reading issues in [Test Anything Protocol (TAP)]{target="_blank"} format.
 
 <!-- more -->
 
@@ -29,6 +29,7 @@ See [Supported Tools] for an updated list of supported tools.
 The addins is available in a version for Cake .NET Tool ([Cake.Issues.Tap]{target="_blank"})
 and Cake Frosting ([Cake.Frosting.Issues.Tap]{target="_blank"}).
 
+[version 5.1.0]: 2025-01-03-cake-issues-v5.1.0-released.md
 [Cake.Issues.Tap addin]: ../../documentation/issue-providers/tap/index.md
 [Test Anything Protocol (TAP)]: https://testanything.org/
 [Supported Tools]: ../../documentation/supported-tools.md

diff --git a/docs/input/news/posts/2025-01-09-cake-issues-v5.2.0-released.md b/docs/input/news/posts/2025-01-09-cake-issues-v5.2.0-released.md
@@ -0,0 +1,107 @@
+---
+title: Cake Issues v5.2.0 Released
+date: 2025-01-09
+categories:
+  - Release Notes
+search:
+  boost: 0.5
+---
+
+Cake Issues version 5.2.0 has been released bringing improvements to build breaking and SARIF issue provider.
+
+<!-- more -->
+
+This post shows the highlights included in this release.
+For update instructions skip to [Updating from previous versions](#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:
+
+* [eoehen](https://github.com/eoehen){target="_blank"}
+* [pascalberger](https://github.com/pascalberger){target="_blank"}
+
+## Support for suppressed issues in SARIF files.
+
+SARIF supports [suppressions]{target="_blank"} 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]{target="_blank"}.
+
+The following example fails build if issues with severity warning or higher from MsBuild are found:
+
+=== "Cake .NET Tool"
+
+    ```csharp
+    BreakBuildOnIssues(
+        issues,
+        new BuildBreakingSettings
+        {
+            MinimumPriority = IssuePriority.Warning,
+            IssueProvidersToConsider = [MsBuildIssuesProviderTypeName]
+        });
+    ```
+
+=== "Cake Frosting"
+
+    ```csharp
+    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:
+
+=== "Cake .NET Tool"
+
+    ```csharp
+    BreakBuildOnIssues(
+        issues,
+        new BuildBreakingSettings
+        {
+            MinimumPriority = IssuePriority.Warning,
+            IssueProvidersToIgnore = [MsBuildIssuesProviderTypeName]
+        });
+    ```
+
+=== "Cake Frosting"
+
+    ```csharp
+    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](https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0){target="_blank"}
+
+[suppressions]: https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/sarif-v2.1.0-errata01-os-complete.html#_Toc141790911
+[aliases for failing builds]: https://cakebuild.net/extensions/cake-issues/#Build-Breaking
+[Cake Issues Recipe]: ../../documentation/recipe/index.md
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -116,7 +116,7 @@ extra:
   # renovate: datasource=nuget depName=Cake.DocFx versioning=loose
   cake_docfx_version: 1.0.0
   # renovate: datasource=nuget depName=Cake.Issues versioning=loose
-  cake_issues_version: 5.1.0
+  cake_issues_version: 5.2.0
   # renovate: datasource=nuget depName=Cake.Markdownlint versioning=loose
   cake_markdownlint_version: 4.0.0
   # renovate: datasource=nuget depName=Cake.Git versioning=loose

diff --git a/nuspec/nuget/Cake.Frosting.Issues.DocFx.nuspec b/nuspec/nuget/Cake.Frosting.Issues.DocFx.nuspec
@@ -29,7 +29,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.DocFx.
     <copyright>Copyright © Cake Issues contributors</copyright>
     <tags>cake cake-addin cake-issues cake-issueprovider linting docfx</tags>
     <readme>docs\README.md</readme>
-    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
     <dependencies>
       <group targetFramework="net8.0">
         <dependency id="Cake.Core" version="5.0" exclude="Build,Analyzers" />

diff --git a/nuspec/nuget/Cake.Frosting.Issues.EsLint.nuspec b/nuspec/nuget/Cake.Frosting.Issues.EsLint.nuspec
@@ -29,7 +29,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.EsLint.
     <copyright>Copyright © Cake Issues contributors</copyright>
     <tags>cake cake-addin cake-issues cake-issueprovider code-analysis javascript linting eslint</tags>
     <readme>docs\README.md</readme>
-    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
     <dependencies>
       <group targetFramework="net8.0">
         <dependency id="Cake.Core" version="5.0" exclude="Build,Analyzers" />

diff --git a/nuspec/nuget/Cake.Frosting.Issues.GitRepository.nuspec b/nuspec/nuget/Cake.Frosting.Issues.GitRepository.nuspec
@@ -29,7 +29,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.GitRepository.
     <copyright>Copyright © Cake Issues contributors</copyright>
     <tags>cake cake-addin cake-issues cake-issueprovider code-analysis linting git</tags>
     <readme>docs\README.md</readme>
-    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
     <dependencies>
       <group targetFramework="net8.0">
         <dependency id="Cake.Core" version="5.0" exclude="Build,Analyzers" />

diff --git a/nuspec/nuget/Cake.Frosting.Issues.InspectCode.nuspec b/nuspec/nuget/Cake.Frosting.Issues.InspectCode.nuspec
@@ -29,7 +29,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.InspectCode.
     <copyright>Copyright © Cake Issues contributors</copyright>
     <tags>cake cake-addin cake-issues cake-issueprovider codeanalysis linting inspectcode</tags>
     <readme>docs\README.md</readme>
-    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
     <dependencies>
       <group targetFramework="net8.0">
         <dependency id="Cake.Core" version="5.0" exclude="Build,Analyzers" />

diff --git a/nuspec/nuget/Cake.Frosting.Issues.Markdownlint.nuspec b/nuspec/nuget/Cake.Frosting.Issues.Markdownlint.nuspec
@@ -29,7 +29,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.Markdownlint.
     <copyright>Copyright © Cake Issues contributors</copyright>
     <tags>cake cake-addin cake-issues cake-issueprovider linting markdown markdownlint</tags>
     <readme>docs\README.md</readme>
-    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
     <dependencies>
       <group targetFramework="net8.0">
         <dependency id="Cake.Core" version="5.0" exclude="Build,Analyzers" />

diff --git a/nuspec/nuget/Cake.Frosting.Issues.MsBuild.nuspec b/nuspec/nuget/Cake.Frosting.Issues.MsBuild.nuspec
@@ -30,7 +30,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.MsBuild.
     <copyright>Copyright © Cake Issues contributors</copyright>
     <tags>cake cake-addin cake-issues cake-issueprovider code-analysis linting msbuild</tags>
     <readme>docs\README.md</readme>
-    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
     <dependencies>
       <group targetFramework="net8.0">
         <dependency id="Cake.Core" version="5.0" exclude="Build,Analyzers" />

diff --git a/nuspec/nuget/Cake.Frosting.Issues.PullRequests.AppVeyor.nuspec b/nuspec/nuget/Cake.Frosting.Issues.PullRequests.AppVeyor.nuspec
@@ -27,7 +27,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.PullRequests.AppVe
     <copyright>Copyright © Cake Issues contributors</copyright>
     <tags>cake cake-addin cake-issues cake-pullrequestsystem issues pullrequest buildserver appveyor</tags>
     <readme>docs\README.md</readme>
-    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
     <dependencies>
       <group targetFramework="net8.0">
         <dependency id="Cake.Common" version="5.0" exclude="Build,Analyzers" />

diff --git a/nuspec/nuget/Cake.Frosting.Issues.PullRequests.AzureDevOps.nuspec b/nuspec/nuget/Cake.Frosting.Issues.PullRequests.AzureDevOps.nuspec
@@ -28,7 +28,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.PullRequests.Azure
     <copyright>Copyright © Cake Issues contributors</copyright>
     <tags>cake cake-addin cake-issues cake-pullrequestsystem issues pullrequest tfs azure-devops azure-devops-server</tags>
     <readme>docs\README.md</readme>
-    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
     <dependencies>
       <group targetFramework="net8.0">
         <dependency id="Cake.Frosting.Issues.PullRequests" version="[5.0.0-beta0001,6.0)" exclude="Build,Analyzers" />

diff --git a/nuspec/nuget/Cake.Frosting.Issues.PullRequests.GitHubActions.nuspec b/nuspec/nuget/Cake.Frosting.Issues.PullRequests.GitHubActions.nuspec
@@ -27,7 +27,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.PullRequests.GitHu
     <copyright>Copyright © Cake Issues contributors</copyright>
     <tags>cake cake-addin cake-issues cake-pullrequestsystem issues pullrequest buildserver github github-actions</tags>
     <readme>docs\README.md</readme>
-    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
     <dependencies>
       <group targetFramework="net8.0">
         <dependency id="Cake.Frosting.Issues.PullRequests" version="[5.0.0-beta0001,6.0)" exclude="Build,Analyzers" />

diff --git a/nuspec/nuget/Cake.Frosting.Issues.PullRequests.nuspec b/nuspec/nuget/Cake.Frosting.Issues.PullRequests.nuspec
@@ -27,7 +27,7 @@ For addin compatible with Cake Script Runners see Cake.Issues.PullRequests.
     <copyright>Copyright © Cake Issues contributors</copyright>
     <tags>Cake Script Cake-Issues CodeAnalysis Linting Issues Pull-Requests</tags>
     <readme>docs\README.md</readme>
-    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
     <dependencies>
       <group targetFramework="net8.0">
         <dependency id="Cake.Core" version="5.0" exclude="Build,Analyzers" />

diff --git a/nuspec/nuget/Cake.Frosting.Issues.Reporting.Console.nuspec b/nuspec/nuget/Cake.Frosting.Issues.Reporting.Console.nuspec
@@ -29,7 +29,7 @@ The addin requires Cake Frosting 1.2.0 or higher.
     <copyright>Copyright © Cake Issues contributors</copyright>
     <tags>cake cake-addin cake-issues cake-reportformat issues reporting console</tags>
     <readme>docs\README.md</readme>
-    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.1.1</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues/releases/tag/5.2.0</releaseNotes>
     <dependencies>
       <group targetFramework="net8.0">
         <dependency id="Cake.Frosting.Issues.Reporting" version="[5.0.0-beta0001,6.0)" exclude="Build,Analyzers" />