Merge branch 'release/5.4.0'

Author: pascalberger

.appveyor.yml

@@ -20,8 +20,8 @@ install:
   - ps: Invoke-WebRequest -Uri "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.ps1" -OutFile "$($env:DOTNET_INSTALL_DIR)/dotnet-install.ps1"
   # .NET 5 required for Codecov.Tool
   - ps: '& "$($env:DOTNET_INSTALL_DIR)/dotnet-install.ps1" -Version 5.0.408 -InstallDir $env:DOTNET_INSTALL_DIR'
-  - ps: '& "$($env:DOTNET_INSTALL_DIR)/dotnet-install.ps1" -Version 8.0.404 -InstallDir $env:DOTNET_INSTALL_DIR'
-  - ps: '& "$($env:DOTNET_INSTALL_DIR)/dotnet-install.ps1" -Version 9.0.101 -InstallDir $env:DOTNET_INSTALL_DIR'
+  - ps: '& "$($env:DOTNET_INSTALL_DIR)/dotnet-install.ps1" -Version 8.0.405 -InstallDir $env:DOTNET_INSTALL_DIR'
+  - ps: '& "$($env:DOTNET_INSTALL_DIR)/dotnet-install.ps1" -Version 9.0.102 -InstallDir $env:DOTNET_INSTALL_DIR'
   - ps: $env:Path = "$env:DOTNET_INSTALL_DIR;$env:Path"
   - ps: dotnet --info
 

.github/workflows/integrationtests.yml

@@ -35,7 +35,7 @@ jobs:
         run: ./build.sh --target=Create-NuGet-Packages
         shell: bash
       - name: Publish NuGet package as build artifact
-        uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4
+        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4
         with:
           name: NuGet Package
           path: ./BuildArtifacts/Packages/NuGet/

docs/input/documentation/assets/tables/supported-tools-copypaste.csv

@@ -1,3 +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
+"[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)",5.4.0

docs/input/documentation/contributing/how-to-build.md

@@ -9,7 +9,7 @@ Ensure the following prerequisites are fulfilled:
 
 * Latest .NET version installed
 
-To build the addins and run unit tests [Cake] is used:
+To build the addins and run unit tests [Cake]{target="_blank"} is used:
 
 === ":material-microsoft-windows: Windows"
 
@@ -44,7 +44,7 @@ Ensure the following prerequisites are fulfilled:
 * Latest .NET version installed
 * Python 3 installed
 
-To build and serve the website [Cake] is used:
+To build and serve the website [Cake]{target="_blank"} is used:
 
 === ":material-microsoft-windows: Windows"
 

docs/input/documentation/contributing/how-to-contribute.md

@@ -3,7 +3,7 @@ title: How to contribute
 description: Instructions how to contribute to Cake Issues addins.
 ---
 
-The repositories are using [GitFlow] with default configuration.
+The repositories are using [GitFlow]{target="_blank"} with default configuration.
 Development is happening on `develop` branch.
 
 To contribute:
@@ -14,6 +14,8 @@ To contribute:
 * Push your feature branch.
 * Create a pull request.
 
-For getting started see issues marked with `Up-for-grabs` in the individual repositories.
+!!! tip
+    For getting started see [issues marked with Up-for-grabs]{target="_blank"}.
 
 [GitFlow]: https://nvie.com/posts/a-successful-git-branching-model/
+[issues marked with Up-for-grabs]: https://github.com/cake-contrib/Cake.Issues/labels/up-for-grabs

docs/input/documentation/contributing/how-to-release.md

@@ -3,6 +3,6 @@ title: How to release addins
 description: Instructions how to release individual Cake Issues addins.
 ---
 
-See [Cake.Recipe documentation] how to create a new release of this addin.
+See [Cake.Recipe documentation]{target="_blank"} how to create a new release of this addin.
 
 [Cake.Recipe documentation]: https://cake-contrib.github.io/Cake.Recipe/docs/usage/creating-release

docs/input/documentation/extending/issue-provider/helper.md

@@ -9,38 +9,3 @@ The following helpers are provider by `Cake.Issues` for simplifying implementati
 |------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
 | [StringPathExtensions](https://cakebuild.net/api/Cake.Issues/StringPathExtensions/){target="_blank"} | Extensions for string for handling paths.                                      |
 | [ByteArrayExtensions](https://cakebuild.net/api/Cake.Issues/ByteArrayExtensions/){target="_blank"}   | Extensions for converting between strings an byte arrays.                      |
-
-## File linking
-
-Cake.Issues provides infrastructure to get links to files on source code hosts like GitHub or Azure Repos.
-This infrastructure can be used inside issue providers to generate file links which can be used inside the issue messages:
-
-```csharp
-protected override IEnumerable<IIssue> InternalReadIssues()
-{
-    var result = new List<IIssue>();
-
-    var filePath = "foo.cs";
-    var line = 10;
-
-    var fileLink = 
-        this.Settings.FileLinkSettings.GetFileLink(
-            IssueBuilder
-                .NewIssue("Issue for creating file link", this)
-                .InFile(filePath, line)
-                .Create()
-        );
-
-    var htmlMessage =
-        $"This is an issues in the file <a href=\"{fileLink}\">{filePath}</a>";
-
-    var issue =
-        IssueBuilder
-            .NewIssue("MyMessage", this)
-            .WithMessageInHtmlFormat(htmlMessage)
-            .InFile(filePath, line)
-            .Create();
-
-    return result;
-}
-```

docs/input/documentation/extending/issue-provider/tutorials/file-linking.md

@@ -0,0 +1,41 @@
+---
+title: File links in message
+description: Instructions how to implement add file links to issue messages.
+---
+
+Cake Issues provides infrastructure to [get links to files] on source code hosts like GitHub or Azure Repos.
+
+This infrastructure can also be used inside an issue providers `InternalReadIssues` method to generate file links
+which can be used inside the issue messages:
+
+```csharp
+protected override IEnumerable<IIssue> InternalReadIssues()
+{
+    var result = new List<IIssue>();
+
+    var filePath = "foo.cs";
+    var line = 10;
+
+    var fileLink = 
+        this.Settings.FileLinkSettings.GetFileLink(
+            IssueBuilder
+                .NewIssue("Issue for creating file link", this)
+                .InFile(filePath, line)
+                .Create()
+        );
+
+    var htmlMessage =
+        $"This is an issues in the file <a href=\"{fileLink}\">{filePath}</a>";
+
+    var issue =
+        IssueBuilder
+            .NewIssue("MyMessage", this)
+            .WithMessageInHtmlFormat(htmlMessage)
+            .InFile(filePath, line)
+            .Create();
+
+    return result;
+}
+```
+
+[get links to files]: ../../../usage/reading-issues/file-linking.md