Update for InspectCode default format change (#949)

Author: pascalberger

docs/input/documentation/issue-providers/inspectcode/examples.md

@@ -47,9 +47,10 @@ and write a log file and a task to read issues from the log file and write the n
 
     Task("Analyze-Project").Does(() =>
     {
-        // Run InspectCode.
+        // Run InspectCode and enforce XML output.
         var settings = new InspectCodeSettings() {
-            OutputFile = logPath
+            OutputFile = logPath,
+            ArgumentCustomization = x => x.Append("-f=xml")
         };
 
         InspectCode(repoRootPath.CombineWithFilePath("MySolution.sln"), settings);
@@ -103,9 +104,10 @@ and write a log file and a task to read issues from the log file and write the n
     {
         public override void Run(BuildContext context)
         {
-            // Run InspectCode.
+            // Run InspectCode and enforce XML output.
             var settings = new InspectCodeSettings() {
-                OutputFile = context.LogPath
+                OutputFile = context.LogPath,
+                ArgumentCustomization = x => x.Append("-f=xml")
             };
         
             context.InspectCode(

docs/input/documentation/issue-providers/inspectcode/features.md

@@ -7,13 +7,21 @@ icon: material/creation-outline
 The [Cake.Issues.InspectCode addin]{target="_blank"} provides the following features.
 
 ??? tip "Tip: Running InspectCode"
-    [JetBrains InsepectCode]{target="_blank"} can be run using the [InspectCode alias]{target="_blank"}.
+    [JetBrains InspectCode]{target="_blank"} can be run using the [InspectCode alias]{target="_blank"}.
 
 ## Basic features
 
-- [x]  Reads warnings from [JetBrains InsepectCode]{target="_blank"} log files.
+- [x]  Reads warnings from [JetBrains InspectCode]{target="_blank"} XML log files.
 - [x]  Provides URLs for issues containing a Wiki URL.
 
+!!! note
+    Starting from version 2024.1, the default output format of [JetBrains InspectCode] is Static Analysis Results Interchange Format (SARIF).
+    The XML format, which was the default in previous versions, will soon be deprecated.
+    Results in the XML format are still available with the `-f="xml"` parameter.
+
+    This issue provider is only for the deprecated XML format.
+    For the new default SARIF format [Cake.Issues.Sarif] can be used.
+
 ## Supported IIssue properties
 
 <div class="annotate" markdown>
@@ -44,6 +52,7 @@ The [Cake.Issues.InspectCode addin]{target="_blank"} provides the following feat
 2.  Set to `IIssue.MessageText`
 3.  Can be set while reading issues
 
-[JetBrains InsepectCode]: https://www.jetbrains.com/help/resharper/InspectCode.html
+[JetBrains InspectCode]: https://www.jetbrains.com/help/resharper/InspectCode.html
 [Cake.Issues.InspectCode addin]: https://cakebuild.net/extensions/cake-issues-inspectcode/
 [InspectCode alias]: https://cakebuild.net/dsl/resharper/#InspectCode
+[Cake.Issues.Sarif]: ../sarif/index.md

docs/input/documentation/issue-providers/inspectcode/index.md

@@ -3,8 +3,16 @@ title: InspectCode
 description: Issue provider which allows you to read issues logged by JetBrains Inspect Code.
 ---
 
-Support for reading issues reported by [JetBrains Inspect Code](https://www.jetbrains.com/help/resharper/2017.1/InspectCode.html)
-is implemented in the [Cake.Issues.InspectCode addin](https://www.nuget.org/packages/Cake.Issues.InspectCode).
+Support for reading issues reported by [JetBrains InspectCode]{target="_blank"} in XML format
+is implemented in the [Cake.Issues.InspectCode addin]{target="_blank"}.
+
+!!! note
+    Starting from version 2024.1, the default output format of [JetBrains InspectCode] is Static Analysis Results Interchange Format (SARIF).
+    The XML format, which was the default in previous versions, will soon be deprecated.
+    Results in the XML format are still available with the `-f="xml"` parameter.
+
+    This issue provider is only for the deprecated XML format.
+    For the new default SARIF format [Cake.Issues.Sarif] can be used.
 
 <div class="grid cards" markdown>
 
@@ -13,3 +21,7 @@ is implemented in the [Cake.Issues.InspectCode addin](https://www.nuget.org/pack
 - :material-api: [API](https://cakebuild.net/extensions/cake-issues-inspectcode){target="_blank"}
 
 </div>
+
+[JetBrains InspectCode]: https://www.jetbrains.com/help/resharper/InspectCode.html
+[Cake.Issues.InspectCode addin]: https://cakebuild.net/extensions/cake-issues-inspectcode/
+[Cake.Issues.Sarif]: ../sarif/index.md