Merge branch 'release/4.0.0'

.appveyor.yml

@@ -11,8 +11,9 @@ install:
   - ps: mkdir $env:DOTNET_INSTALL_DIR -Force | Out-Null
   - ps: Invoke-WebRequest -Uri "https://dotnet.microsoft.com/download/dotnet/scripts/v1/dotnet-install.ps1" -OutFile "$($env:DOTNET_INSTALL_DIR)/dotnet-install.ps1"
   - 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 6.0.405 -InstallDir $env:DOTNET_INSTALL_DIR'
-  - ps: '& "$($env:DOTNET_INSTALL_DIR)/dotnet-install.ps1" -Version 7.0.102 -InstallDir $env:DOTNET_INSTALL_DIR'
+  - ps: '& "$($env:DOTNET_INSTALL_DIR)/dotnet-install.ps1" -Version 6.0.417 -InstallDir $env:DOTNET_INSTALL_DIR'
+  - ps: '& "$($env:DOTNET_INSTALL_DIR)/dotnet-install.ps1" -Version 7.0.404 -InstallDir $env:DOTNET_INSTALL_DIR'
+  - ps: '& "$($env:DOTNET_INSTALL_DIR)/dotnet-install.ps1" -Version 8.0.100 -InstallDir $env:DOTNET_INSTALL_DIR'
   - ps: $env:Path = "$env:DOTNET_INSTALL_DIR;$env:Path"
   - ps: dotnet --info
 

.github/renovate.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "github>cake-contrib/renovate-presets:cake-issues",
+    "github>cake-contrib/renovate-presets:frosting-addin"
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "dotnet.defaultSolution": "src\\Cake.Issues.MsBuild.sln"
+}

azure-pipelines.yml

@@ -27,5 +27,9 @@ jobs:
     inputs:
       version: '7.x'
     displayName: 'Install .NET 7'
+  - task: UseDotNet@2
+    inputs:
+      version: '8.x'
+    displayName: 'Install .NET 8'
   - powershell: ./build.ps1
     displayName: 'Cake Build'

docs/examples.md

@@ -72,4 +72,4 @@ Task("Read-Issues")
     });
 ```
 
-[MSBuild Extension Pack]: http://www.msbuildextensionpack.com/
+[MSBuild Extension Pack]: https://github.com/mikefourie-zz/MSBuildExtensionPack

docs/features.md

@@ -41,7 +41,7 @@ The [Cake.Issues.MsBuild addin] provides the following features.
 | <span class="glyphicon glyphicon-ok" style="color:green"></span>   | `IIssue.RuleUrl`                  | For code analysis (`CA*`) and StyleCop (`SA*`) warnings. Support for additional rules can be added through a custom [MsBuildAddRuleUrlResolver] |
 
 [Cake.Issues.MsBuild addin]: https://www.nuget.org/packages/Cake.Issues.MsBuild
-[MSBuild Extension Pack XmlFileLogger]: http://www.msbuildextensionpack.com/help/4.0.5.0/html/242ab4fd-c2e2-f6aa-325b-7588725aed24.htm
+[MSBuild Extension Pack XmlFileLogger]: https://github.com/mikefourie-zz/MSBuildExtensionPack/blob/master/Solutions/Main/Loggers/Framework/XmlFileLogger.cs
 [MsBuildAddRuleUrlResolver]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487
 [MsBuildBinaryLogFileFormat]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/AD50C7E1
 [MsBuildXmlFileLoggerFormat]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/051D7B6E

global.json

@@ -0,0 +1,7 @@
+{
+    "sdk": {
+        "allowPrerelease": true,
+        "version": "8.0.100",
+        "rollForward": "latestFeature"
+    }
+}

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

@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="utf-8"?>
+<package xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <metadata xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
+    <id>Cake.Frosting.Issues.MsBuild</id>
+    <title>Cake.Frosting.Issues.MsBuild</title>
+    <version>0.0.0</version>
+    <authors>BBT Software AG and contributors</authors>
+    <owners>bbtsoftware, pascalberger, cake-contrib</owners>
+    <summary>MsBuild support for the Cake.Issues addin for Cake Frosting</summary>
+    <description>
+The MsBuild support for the Cake.Issues addin for Cake allows you to read issues logged as warnings in a MsBuild log.
+
+This addin provides the aliases for reading MsBuild warnings and providing them to the Cake.Issues addin.
+It also requires the core Cake.Issues addin.
+
+There are also additional addins for generating reports or posting issues to pull requests.
+
+See the Project Site for an overview of the whole ecosystem of addins for working with issues in Cake scripts.
+
+
+NOTE:
+This is the version of the addin compatible with Cake Frosting.
+For addin compatible with Cake Script Runners see Cake.Issues.MsBuild.
+    </description>
+    <license type="expression">MIT</license>
+    <projectUrl>https://cakeissues.net</projectUrl>
+    <icon>icon.png</icon>
+    <requireLicenseAcceptance>false</requireLicenseAcceptance>
+    <repository type="git" url="https://github.com/cake-contrib/Cake.Issues.MsBuild.git"/>
+    <copyright>Copyright © BBT Software AG and contributors</copyright>
+    <tags>cake cake-addin cake-issues cake-issueprovider code-analysis linting msbuild</tags>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues.MsBuild/releases/tag/4.0.0</releaseNotes>
+    <dependencies>
+      <group targetFramework="net6.0">
+        <dependency id="Cake.Core" version="4.0" exclude="Build,Analyzers" />
+        <dependency id="Cake.Issues" version="[4.0.0-beta0001,5.0)" exclude="Build,Analyzers" />
+        <dependency id="MSBuild.StructuredLogger" version="2.2.100" exclude="Build,Analyzers" />
+      </group>
+      <group targetFramework="net7.0">
+        <dependency id="Cake.Core" version="4.0" exclude="Build,Analyzers" />
+        <dependency id="Cake.Issues" version="[4.0.0-beta0001,5.0)" exclude="Build,Analyzers" />
+        <dependency id="MSBuild.StructuredLogger" version="2.2.100" exclude="Build,Analyzers" />
+      </group>
+      <group targetFramework="net8.0">
+        <dependency id="Cake.Core" version="4.0" exclude="Build,Analyzers" />
+        <dependency id="Cake.Issues" version="[4.0.0-beta0001,5.0)" exclude="Build,Analyzers" />
+        <dependency id="MSBuild.StructuredLogger" version="2.2.100" exclude="Build,Analyzers" />
+      </group>
+    </dependencies>
+  </metadata>
+  <files>
+    <file src="icon.png" target="" />
+    <file src="..\..\src\Cake.Issues.MsBuild\bin\Release\net6.0\Cake.Issues.MsBuild.dll" target="lib\net6.0" />
+    <file src="..\..\src\Cake.Issues.MsBuild\bin\Release\net6.0\Cake.Issues.MsBuild.pdb" target="lib\net6.0" />
+    <file src="..\..\src\Cake.Issues.MsBuild\bin\Release\net6.0\Cake.Issues.MsBuild.xml" target="lib\net6.0" />
+    <file src="..\..\src\Cake.Issues.MsBuild\bin\Release\net7.0\Cake.Issues.MsBuild.dll" target="lib\net7.0" />
+    <file src="..\..\src\Cake.Issues.MsBuild\bin\Release\net7.0\Cake.Issues.MsBuild.pdb" target="lib\net7.0" />
+    <file src="..\..\src\Cake.Issues.MsBuild\bin\Release\net7.0\Cake.Issues.MsBuild.xml" target="lib\net7.0" />
+    <file src="..\..\src\Cake.Issues.MsBuild\bin\Release\net8.0\Cake.Issues.MsBuild.dll" target="lib\net8.0" />
+    <file src="..\..\src\Cake.Issues.MsBuild\bin\Release\net8.0\Cake.Issues.MsBuild.pdb" target="lib\net8.0" />
+    <file src="..\..\src\Cake.Issues.MsBuild\bin\Release\net8.0\Cake.Issues.MsBuild.xml" target="lib\net8.0" />
+  </files>
+</package>

nuspec/nuget/Cake.Issues.MsBuild.nuspec

@@ -16,6 +16,10 @@ It also requires the core Cake.Issues addin.
 There are also additional addins for generating reports or posting issues to pull requests.
 
 See the Project Site for an overview of the whole ecosystem of addins for working with issues in Cake scripts.
+
+NOTE:
+This is the version of the addin compatible with Cake Script Runners.
+For addin compatible with Cake Frosting see Cake.Frosting.Issues.MsBuild.
     </description>
     <license type="expression">MIT</license>
     <projectUrl>https://cakeissues.net</projectUrl>
@@ -24,7 +28,7 @@ See the Project Site for an overview of the whole ecosystem of addins for workin
     <repository type="git" url="https://github.com/cake-contrib/Cake.Issues.MsBuild.git"/>
     <copyright>Copyright © BBT Software AG and contributors</copyright>
     <tags>cake cake-addin cake-issues cake-issueprovider code-analysis linting msbuild</tags>
-    <releaseNotes>https://github.com/cake-contrib/Cake.Issues.MsBuild/releases/tag/3.0.0</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.Issues.MsBuild/releases/tag/4.0.0</releaseNotes>
   </metadata>
   <files>
     <file src="..\..\..\..\nuspec\nuget\icon.png" target="" />
@@ -40,5 +44,11 @@ See the Project Site for an overview of the whole ecosystem of addins for workin
     <file src="net7.0\StructuredLogger.dll" target="lib\net7.0" />
     <file src="net7.0\Microsoft.Build.Framework.dll" target="lib\net7.0" />
     <file src="net7.0\Microsoft.Build.Utilities.Core.dll" target="lib\net7.0" />
+    <file src="net8.0\Cake.Issues.MsBuild.dll" target="lib\net8.0" />
+    <file src="net8.0\Cake.Issues.MsBuild.pdb" target="lib\net8.0" />
+    <file src="net8.0\Cake.Issues.MsBuild.xml" target="lib\net8.0" />
+    <file src="net8.0\StructuredLogger.dll" target="lib\net8.0" />
+    <file src="net8.0\Microsoft.Build.Framework.dll" target="lib\net8.0" />
+    <file src="net8.0\Microsoft.Build.Utilities.Core.dll" target="lib\net8.0" />
   </files>
 </package>

recipe.cake

@@ -1,4 +1,4 @@
-#load nuget:?package=Cake.Recipe&version=3.0.0
+#load nuget:?package=Cake.Recipe&version=3.1.1
 
 //*************************************************************************************************
 // Settings

src/Cake.Issues.MsBuild.Tests/Cake.Issues.MsBuild.Tests.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net6.0;net7.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
     <IsPackable>false</IsPackable>
     <Product>Cake.Issues</Product>
     <Copyright>Copyright © BBT Software AG and contributors</Copyright>
@@ -24,15 +24,15 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.1" />
-    <PackageReference Include="Cake.Core" Version="3.0.0" />
-    <PackageReference Include="Cake.Testing" Version="3.0.0" />
-    <PackageReference Include="Cake.Issues" Version="3.0.0" />
-    <PackageReference Include="Cake.Issues.Testing" Version="3.0.0" />
-    <PackageReference Include="Shouldly" Version="4.1.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
+    <PackageReference Include="Cake.Core" Version="4.0.0" />
+    <PackageReference Include="Cake.Testing" Version="4.0.0" />
+    <PackageReference Include="Cake.Issues" Version="4.0.0" />
+    <PackageReference Include="Cake.Issues.Testing" Version="4.0.0" />
+    <PackageReference Include="Shouldly" Version="4.2.1" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" />
-    <PackageReference Include="xunit" Version="2.4.2" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5" />
+    <PackageReference Include="xunit" Version="2.6.3" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.5" />
   </ItemGroup>
 
   <ItemGroup>

src/Cake.Issues.MsBuild.Tests/FakeMsBuildLogFileFormat.cs

@@ -4,13 +4,8 @@
     using System.Collections.Generic;
     using Cake.Core.Diagnostics;
 
-    internal class FakeMsBuildLogFileFormat : BaseMsBuildLogFileFormat
+    internal class FakeMsBuildLogFileFormat(ICakeLog log) : BaseMsBuildLogFileFormat(log)
     {
-        public FakeMsBuildLogFileFormat(ICakeLog log)
-           : base(log)
-        {
-        }
-
         public new (bool Valid, string FilePath) ValidateFilePath(string filePath, IRepositorySettings repositorySettings)
         {
             return base.ValidateFilePath(filePath, repositorySettings);

src/Cake.Issues.MsBuild.sln.DotSettings

@@ -1,3 +1,12 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
 	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=ArrangeThisQualifier/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=ConvertToUsingDeclaration/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=MemberCanBePrivate_002EGlobal/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=ParameterHidesMember/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=RedundantNameQualifier/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=UnusedMember_002EGlobal/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeInspection/Highlighting/InspectionSeverities/=UnusedType_002EGlobal/@EntryIndexedValue">DO_NOT_SHOW</s:String>
+	<s:String x:Key="/Default/CodeStyle/CodeFormatting/CSharpCodeStyle/ThisQualifier/INSTANCE_MEMBERS_QUALIFY_MEMBERS/@EntryValue">Field, Property, Event, Method</s:String>
+
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/PredefinedNamingRules/=PrivateInstanceFields/@EntryIndexedValue">&lt;Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /&gt;</s:String></wpf:ResourceDictionary>

src/Cake.Issues.MsBuild/Cake.Issues.MsBuild.csproj

@@ -1,7 +1,7 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net6.0;net7.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
     <Description>MsBuild support for the Cake.Issues Addin for Cake Build Automation System</Description>
     <Authors>BBT Software AG</Authors>
     <Company>BBT Software AG</Company>
@@ -19,14 +19,28 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Cake.Core" Version="3.0.0" />
-    <PackageReference Include="Cake.Issues" Version="3.0.0" />
-    <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="7.0.0">
+    <PackageReference Include="Cake.Core" Version="4.0.0" />
+    <PackageReference Include="Cake.Issues" Version="4.0.0" />
+    <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="8.0.0">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="MSBuild.StructuredLogger" Version="2.1.815" />
+    <PackageReference Include="MSBuild.StructuredLogger" Version="2.2.100" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" />
   </ItemGroup>
 
+  <!-- 
+    Workaround to make sure correct Microsoft.Build.Framework.dll version is copied to output for net6.0.
+    Since it has a ref folder for netstandard2.0 and only target folder for net472 and net7.0, we need to copy it manually for net6.0.
+    See https://github.com/KirillOsenkov/MSBuildStructuredLog/issues/692.
+  -->
+  <ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
+    <PackageReference Include="Microsoft.Build.Framework" Version="17.5.0" ExcludeAssets="all" PrivateAssets="all" GeneratePathProperty="true" />
+    <PackageReference Include="Microsoft.Build.Utilities.Core" Version="17.5.0" ExcludeAssets="all" PrivateAssets="all" GeneratePathProperty="true" />
+  </ItemGroup>
+
+  <ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
+    <Reference Include="$(PkgMicrosoft_Build_Framework)\lib\net472\Microsoft.Build.Framework.dll" />
+    <Reference Include="$(PkgMicrosoft_Build_Utilities_Core)\lib\net472\Microsoft.Build.Utilities.Core.dll" />
+  </ItemGroup>
 </Project>

src/Cake.Issues.MsBuild/LogFileFormat/BinaryLogFileFormat.cs

@@ -10,17 +10,9 @@
     /// <summary>
     /// MsBuild binary log file format.
     /// </summary>
-    internal class BinaryLogFileFormat : BaseMsBuildLogFileFormat
+    /// <param name="log">The Cake log instance.</param>
+    internal class BinaryLogFileFormat(ICakeLog log) : BaseMsBuildLogFileFormat(log)
     {
-        /// <summary>
-        /// Initializes a new instance of the <see cref="BinaryLogFileFormat"/> class.
-        /// </summary>
-        /// <param name="log">The Cake log instance.</param>
-        public BinaryLogFileFormat(ICakeLog log)
-            : base(log)
-        {
-        }
-
         /// <inheritdoc/>
         public override IEnumerable<IIssue> ReadIssues(
             MsBuildIssuesProvider issueProvider,

src/Cake.Issues.MsBuild/LogFileFormat/XmlFileLoggerLogFileFormat.cs

@@ -10,17 +10,9 @@
     /// <summary>
     /// MsBuild log format as written by the <c>XmlFileLogger</c> class from MSBuild Extension Pack.
     /// </summary>
-    internal class XmlFileLoggerLogFileFormat : BaseMsBuildLogFileFormat
+    /// <param name="log">The Cake log instance.</param>
+    internal class XmlFileLoggerLogFileFormat(ICakeLog log) : BaseMsBuildLogFileFormat(log)
     {
-        /// <summary>
-        /// Initializes a new instance of the <see cref="XmlFileLoggerLogFileFormat"/> class.
-        /// </summary>
-        /// <param name="log">The Cake log instance.</param>
-        public XmlFileLoggerLogFileFormat(ICakeLog log)
-            : base(log)
-        {
-        }
-
         /// <inheritdoc/>
         public override IEnumerable<IIssue> ReadIssues(
             MsBuildIssuesProvider issueProvider,
@@ -54,14 +46,14 @@ public override IEnumerable<IIssue> ReadIssues(
                 }
 
                 // Read affected project from the warning or error.
-                if (!this.TryGetProject(element, repositorySettings, out string projectFileRelativePath))
+                if (!this.TryGetProject(element, repositorySettings, out var projectFileRelativePath))
                 {
                     this.Log.Information("Skip element since project could not be parsed");
                     continue;
                 }
 
                 // Read affected file from the warning or error.
-                if (!this.TryGetFile(element, repositorySettings, out string fileName))
+                if (!this.TryGetFile(element, repositorySettings, out var fileName))
                 {
                     this.Log.Information("Skip element since file path could not be parsed");
                     continue;
@@ -82,7 +74,7 @@ public override IEnumerable<IIssue> ReadIssues(
                 }
 
                 // Read rule code from the warning or error.
-                if (!this.TryGetRule(element, out string rule))
+                if (!this.TryGetRule(element, out var rule))
                 {
                     this.Log.Information("Skip element since rule could not be parsed");
                     continue;

src/Cake.Issues.MsBuild/MsBuildIssuesAliases.cs

@@ -4,6 +4,9 @@
 
     /// <summary>
     /// Contains functionality for reading warnings from MSBuild log files.
+    ///
+    /// NOTE: Use Cake.Issues.MsBuild addin to use these aliases with Cake Script Runners and
+    /// Cake.Frosting.Issues.MsBuild to use these aliases with Cake Frosting.
     /// </summary>
     [CakeAliasCategory(IssuesAliasConstants.MainCakeAliasCategory)]
     public static partial class MsBuildIssuesAliases

src/Cake.Issues.MsBuild/MsBuildIssuesProvider.cs

@@ -5,18 +5,10 @@
     /// <summary>
     /// Provider for issues reported as MsBuild warnings.
     /// </summary>
-    public class MsBuildIssuesProvider : BaseMultiFormatIssueProvider<MsBuildIssuesSettings, MsBuildIssuesProvider>
+    /// <param name="log">The Cake log context.</param>
+    /// <param name="settings">Settings for reading the log file.</param>
+    public class MsBuildIssuesProvider(ICakeLog log, MsBuildIssuesSettings settings) : BaseMultiFormatIssueProvider<MsBuildIssuesSettings, MsBuildIssuesProvider>(log, settings)
     {
-        /// <summary>
-        /// Initializes a new instance of the <see cref="MsBuildIssuesProvider"/> class.
-        /// </summary>
-        /// <param name="log">The Cake log context.</param>
-        /// <param name="settings">Settings for reading the log file.</param>
-        public MsBuildIssuesProvider(ICakeLog log, MsBuildIssuesSettings settings)
-            : base(log, settings)
-        {
-        }
-
         /// <summary>
         /// Gets the name of the MsBuild issue provider.
         /// This name can be used to identify issues based on the <see cref="IIssue.ProviderType"/> property.