From aa804aed5dacbc0d5ae99086f0229c61fddad5ba Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Thu, 15 Aug 2019 11:28:49 +0200 Subject: [PATCH 01/18] Add code owners --- .github/CODEOWNERS | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .github/CODEOWNERS diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..da37e81 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,3 @@ +# These owners will be the default owners for everything in the repo and +# will be requested for review when someone opens a pull request. +* @pascalberger @christianbumann @x-jokay @silanosa @georgesgoetz \ No newline at end of file From 76301e8470113177af5a0d02a3490864d63bee2a Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Wed, 6 Sep 2017 20:10:58 +0200 Subject: [PATCH 02/18] Initial version --- features.md | 16 ++++++++++++++++ index.cshtml | 12 ++++++++++++ requirements.md | 10 ++++++++++ 3 files changed, 38 insertions(+) create mode 100644 features.md create mode 100644 index.cshtml create mode 100644 requirements.md diff --git a/features.md b/features.md new file mode 100644 index 0000000..9dd4152 --- /dev/null +++ b/features.md @@ -0,0 +1,16 @@ +--- +Order: 20 +Title: Features +Description: Features of the Cake.Issues.MsBuild addin. +--- +The [Cake.Issues.MsBuild addin] provides the following features: + +* Reads warnings from MSBuild log files. +* Supported log file formats: + * [MSBuild Extension Pack XmlFileLogger] +* Provides URLs for all code analysis (`CA*`) and StyleCop (`SA*`) warnings. +* Support for custom URL resolving using the [MsBuildAddRuleUrlResolver] alias. + +[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 +[MsBuildAddRuleUrlResolver]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487 \ No newline at end of file diff --git a/index.cshtml b/index.cshtml new file mode 100644 index 0000000..394da87 --- /dev/null +++ b/index.cshtml @@ -0,0 +1,12 @@ +--- +Title: MsBuild +Description: Issue provider which allows you to read warnings logged by MsBuild. +--- +

@Html.Raw(Model.String(DocsKeys.Description))

+ +

+ Support for reading warnings reported by MsBuild is implemented in the + Cake.Issues.MsBuild addin. +

+ +@Html.Partial("_ChildPages") \ No newline at end of file diff --git a/requirements.md b/requirements.md new file mode 100644 index 0000000..b9fd46f --- /dev/null +++ b/requirements.md @@ -0,0 +1,10 @@ +--- +Order: 10 +Title: Requirements +Description: Requirements for the Cake.Issues.MsBuild addin. +--- +To use the [Cake.Issues.MsBuild addin] the following requirements need to be fulfilled: + +* Cake 0.16.2 or newer. + +[Cake.Issues.MsBuild addin]: https://www.nuget.org/packages/Cake.Issues.MsBuild \ No newline at end of file From 728d4a1f3da14b15e2616420a2158e51a7a9a424 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Wed, 13 Sep 2017 17:37:50 +0200 Subject: [PATCH 03/18] Update requirement to Cake 0.22.0 --- requirements.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.md b/requirements.md index b9fd46f..302a24a 100644 --- a/requirements.md +++ b/requirements.md @@ -5,6 +5,6 @@ Description: Requirements for the Cake.Issues.MsBuild addin. --- To use the [Cake.Issues.MsBuild addin] the following requirements need to be fulfilled: -* Cake 0.16.2 or newer. +* Cake 0.22.0 or newer. [Cake.Issues.MsBuild addin]: https://www.nuget.org/packages/Cake.Issues.MsBuild \ No newline at end of file From 271a2c11da2d167145651715e350493300016032 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Sun, 17 Sep 2017 21:10:51 +0200 Subject: [PATCH 04/18] (GH-5) Add MsBuild issue provider example --- examples.md | 69 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 examples.md diff --git a/examples.md b/examples.md new file mode 100644 index 0000000..7513781 --- /dev/null +++ b/examples.md @@ -0,0 +1,69 @@ +--- +Order: 30 +Title: Examples +Description: Examples for using the Cake.Issues.MsBuild addin. +--- +The following example will call MsBuild to build the solution and outputs the number of warnings. + +To read issues from MsBuild log files you need to import the core addin and the MsBuild support: + +```csharp +#addin "Cake.Issues" +#addin "Cake.Issues.MsBuild" +``` + +In this example the log file is written by the `XmlFileLogger` class from [MSBuild Extension Pack]. +In order to use the above logger, the following line will download and install the tool from NuGet.org: + +```csharp +#tool "nuget:?package=MSBuild.Extension.Pack" +``` + +We need some global variables: + +```csharp +var logPath = @"c:\build\msbuild.log"; +var repoRootPath = @"c:\repo"; +``` + +The following task will build the solution and write a log file: + +```csharp +Task("Build-Solution").Does(() => +{ + // Build solution. + var settings = + new MSBuildSettings() + .WithLogger( + Context.Tools.Resolve("MSBuild.ExtensionPack.Loggers.dll").FullPath, + "XmlFileLogger", + string.Format( + "logfile=\"{0}\";verbosity=Detailed;encoding=UTF-8", + logPath) + ); + + MSBuild(repoRootPath.CombineWithFilePath("MySolution.sln"), settings); +}); +``` + +Finally you can define a task where you call the core addin with the desired issue provider. +The following example reads issues reported as MsBuild warnings by the `XmlFileLogger` +class from [MSBuild Extension Pack]: + +```csharp +Task("Analyze-Log") +.IsDependentOn("Build-Solution") +.Does(() => +{ + // Read Issues. + var issues = ReadIssues( + MsBuildIssuesFromFilePath( + logPath, + MsBuildXmlFileLoggerFormat), + repoRootFolder); + + Information("{0} issues are found.", issues.Count()); +}); +``` + +[MSBuild Extension Pack]: http://www.msbuildextensionpack.com/ \ No newline at end of file From 25dd6dd989d3de856cbdd63b2ac44b867c75edf3 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Sun, 17 Sep 2017 22:20:05 +0200 Subject: [PATCH 05/18] (GH-12) Add documentation about supported comment format for each issue provider --- features.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/features.md b/features.md index 9dd4152..48de4b2 100644 --- a/features.md +++ b/features.md @@ -8,6 +8,8 @@ The [Cake.Issues.MsBuild addin] provides the following features: * Reads warnings from MSBuild log files. * Supported log file formats: * [MSBuild Extension Pack XmlFileLogger] +* Supported comment formats: + * Plain text * Provides URLs for all code analysis (`CA*`) and StyleCop (`SA*`) warnings. * Support for custom URL resolving using the [MsBuildAddRuleUrlResolver] alias. From b48403132590e5cf80ea2ed86de88b2b13dd4317 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Fri, 13 Oct 2017 22:09:20 +0200 Subject: [PATCH 06/18] Document properties set on IIssue for each issue provider --- features.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/features.md b/features.md index 48de4b2..74d8265 100644 --- a/features.md +++ b/features.md @@ -12,7 +12,20 @@ The [Cake.Issues.MsBuild addin] provides the following features: * Plain text * Provides URLs for all code analysis (`CA*`) and StyleCop (`SA*`) warnings. * Support for custom URL resolving using the [MsBuildAddRuleUrlResolver] alias. +* Supported `IIssue` properties: + * [ProviderType] + * [AffectedFileRelativePath] + * [Line] + * [Message] + * [Rule] + * [RuleUrl] [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 -[MsBuildAddRuleUrlResolver]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487 \ No newline at end of file +[MsBuildAddRuleUrlResolver]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487 +[ProviderType]: ../../api/Cake.Issues/IIssue/D5A24C72 +[AffectedFileRelativePath]: ../../api/Cake.Issues/IIssue/BF0CD6F1 +[Line]: ../../api/Cake.Issues/IIssue/F2A42E89 +[Message]: ../../api/Cake.Issues/IIssue/18537A3D +[Rule]: ../../api/Cake.Issues/IIssue/C8BCE21E +[RuleUrl]: ../../api/Cake.Issues/IIssue/48A6F355 \ No newline at end of file From 0e1ae898814e46faab552fb629a1098182ae24c3 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Fri, 25 May 2018 13:15:30 +0200 Subject: [PATCH 07/18] Link requirements to release notes --- requirements.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/requirements.md b/requirements.md index 302a24a..c8046f4 100644 --- a/requirements.md +++ b/requirements.md @@ -3,8 +3,7 @@ Order: 10 Title: Requirements Description: Requirements for the Cake.Issues.MsBuild addin. --- -To use the [Cake.Issues.MsBuild addin] the following requirements need to be fulfilled: +The requirements for using the [Cake.Issues.MsBuild addin] are listed in the [release notes] for any specific version. -* Cake 0.22.0 or newer. - -[Cake.Issues.MsBuild addin]: https://www.nuget.org/packages/Cake.Issues.MsBuild \ No newline at end of file +[Cake.Issues.MsBuild addin]: https://www.nuget.org/packages/Cake.Issues.MsBuild +[release notes]: release-notes \ No newline at end of file From 7f743464ec86a36ee07dc01a3e87ccf0e62a93b7 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Mon, 4 Jun 2018 22:18:12 +0200 Subject: [PATCH 08/18] Update features for 0.3.0 release --- features.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/features.md b/features.md index 74d8265..b202fbc 100644 --- a/features.md +++ b/features.md @@ -14,18 +14,25 @@ The [Cake.Issues.MsBuild addin] provides the following features: * Support for custom URL resolving using the [MsBuildAddRuleUrlResolver] alias. * Supported `IIssue` properties: * [ProviderType] + * [ProviderName] * [AffectedFileRelativePath] * [Line] * [Message] + * [Priority] (Always [IssuePriority.Warning]) + * [PriorityName] (Always [IssuePriority.Warning]) * [Rule] * [RuleUrl] [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 -[MsBuildAddRuleUrlResolver]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487 -[ProviderType]: ../../api/Cake.Issues/IIssue/D5A24C72 -[AffectedFileRelativePath]: ../../api/Cake.Issues/IIssue/BF0CD6F1 -[Line]: ../../api/Cake.Issues/IIssue/F2A42E89 -[Message]: ../../api/Cake.Issues/IIssue/18537A3D -[Rule]: ../../api/Cake.Issues/IIssue/C8BCE21E -[RuleUrl]: ../../api/Cake.Issues/IIssue/48A6F355 \ No newline at end of file +[MsBuildAddRuleUrlResolver]: ../../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487 +[ProviderType]: ../../../api/Cake.Issues/IIssue/D5A24C72 +[ProviderName]: ../../../api/Cake.Issues/IIssue/FA8BB1A0 +[AffectedFileRelativePath]: ../../../api/Cake.Issues/IIssue/BF0CD6F1 +[Line]: ../../../api/Cake.Issues/IIssue/F2A42E89 +[Message]: ../../../api/Cake.Issues/IIssue/18537A3D +[Priority]: ../../../api/Cake.Issues/IIssue/BFEFFBB1 +[PriorityName]: ../../../api/Cake.Issues/IIssue/05A39052 +[Rule]: ../../../api/Cake.Issues/IIssue/C8BCE21E +[RuleUrl]: ../../../api/Cake.Issues/IIssue/48A6F355 +[IssuePriority.Warning]: ../../../api/Cake.Issues/IssuePriority/7A0CE07F \ No newline at end of file From b1e545c22a6d7469a35cabec8aa26c356e507783 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Mon, 4 Jun 2018 22:36:53 +0200 Subject: [PATCH 09/18] Fix link --- features.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/features.md b/features.md index b202fbc..16be730 100644 --- a/features.md +++ b/features.md @@ -25,7 +25,7 @@ The [Cake.Issues.MsBuild addin] provides the following features: [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 -[MsBuildAddRuleUrlResolver]: ../../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487 +[MsBuildAddRuleUrlResolver]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487 [ProviderType]: ../../../api/Cake.Issues/IIssue/D5A24C72 [ProviderName]: ../../../api/Cake.Issues/IIssue/FA8BB1A0 [AffectedFileRelativePath]: ../../../api/Cake.Issues/IIssue/BF0CD6F1 From 16e5fa110d6f7eb520c401eb23038cc7c97f7c5f Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Tue, 26 Jun 2018 12:39:14 +0200 Subject: [PATCH 10/18] MsBuild issue provider returns project as of version 0.3.1 --- features.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/features.md b/features.md index 16be730..3cbc1fb 100644 --- a/features.md +++ b/features.md @@ -15,6 +15,7 @@ The [Cake.Issues.MsBuild addin] provides the following features: * Supported `IIssue` properties: * [ProviderType] * [ProviderName] + * [Project] * [AffectedFileRelativePath] * [Line] * [Message] @@ -28,6 +29,7 @@ The [Cake.Issues.MsBuild addin] provides the following features: [MsBuildAddRuleUrlResolver]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487 [ProviderType]: ../../../api/Cake.Issues/IIssue/D5A24C72 [ProviderName]: ../../../api/Cake.Issues/IIssue/FA8BB1A0 +[Project]: ../../../api/Cake.Issues/IIssue/89B374A4 [AffectedFileRelativePath]: ../../../api/Cake.Issues/IIssue/BF0CD6F1 [Line]: ../../../api/Cake.Issues/IIssue/F2A42E89 [Message]: ../../../api/Cake.Issues/IIssue/18537A3D @@ -35,4 +37,4 @@ The [Cake.Issues.MsBuild addin] provides the following features: [PriorityName]: ../../../api/Cake.Issues/IIssue/05A39052 [Rule]: ../../../api/Cake.Issues/IIssue/C8BCE21E [RuleUrl]: ../../../api/Cake.Issues/IIssue/48A6F355 -[IssuePriority.Warning]: ../../../api/Cake.Issues/IssuePriority/7A0CE07F \ No newline at end of file +[IssuePriority.Warning]: ../../../api/Cake.Issues/IssuePriority/7A0CE07F From d3eee25851f1367c7f54b6bbdf83aa7fd747799f Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Sat, 28 Jul 2018 13:04:59 +0200 Subject: [PATCH 11/18] Update issue provider features for 0.4.0 --- features.md | 58 +++++++++++++++++++++++++++++------------------------ 1 file changed, 32 insertions(+), 26 deletions(-) diff --git a/features.md b/features.md index 3cbc1fb..7a17354 100644 --- a/features.md +++ b/features.md @@ -3,38 +3,44 @@ Order: 20 Title: Features Description: Features of the Cake.Issues.MsBuild addin. --- -The [Cake.Issues.MsBuild addin] provides the following features: +The [Cake.Issues.MsBuild addin] provides the following features. + +# Basic features * Reads warnings from MSBuild log files. -* Supported log file formats: - * [MSBuild Extension Pack XmlFileLogger] -* Supported comment formats: - * Plain text * Provides URLs for all code analysis (`CA*`) and StyleCop (`SA*`) warnings. * Support for custom URL resolving using the [MsBuildAddRuleUrlResolver] alias. -* Supported `IIssue` properties: - * [ProviderType] - * [ProviderName] - * [Project] - * [AffectedFileRelativePath] - * [Line] - * [Message] - * [Priority] (Always [IssuePriority.Warning]) - * [PriorityName] (Always [IssuePriority.Warning]) - * [Rule] - * [RuleUrl] + +# Supported log file formats + +* [MsBuildXmlFileLoggerFormat] alias for reading issues from log files created by [MSBuild Extension Pack XmlFileLogger]. + +# Supported comment formats + +| | Comment format | Remarks | +|--------------------------------------------------------------------|--------------------------------|--------------------------------| +| | `IssueCommentFormat.PlainText` | | +| | `IssueCommentFormat.Markdown` | | +| | `IssueCommentFormat.Html` | | + +# Supported IIssue properties + +| | Property | Remarks | +|------------------------------------------------------------------|-----------------------------------|--------------------------------| +| | `IIssue.ProviderType` | | +| | `IIssue.ProviderName` | | +| | `IIssue.ProjectName` | | +| | `IIssue.ProjectFileRelativePath` | | +| | `IIssue.AffectedFileRelativePath` | | +| | `IIssue.Line` | | +| | `IIssue.Message` | | +| | `IIssue.Priority` | Always [IssuePriority.Warning] | +| | `IIssue.PriorityName` | Always [IssuePriority.Warning] | +| | `IIssue.Rule` | | +| | `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 [MsBuildAddRuleUrlResolver]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487 -[ProviderType]: ../../../api/Cake.Issues/IIssue/D5A24C72 -[ProviderName]: ../../../api/Cake.Issues/IIssue/FA8BB1A0 -[Project]: ../../../api/Cake.Issues/IIssue/89B374A4 -[AffectedFileRelativePath]: ../../../api/Cake.Issues/IIssue/BF0CD6F1 -[Line]: ../../../api/Cake.Issues/IIssue/F2A42E89 -[Message]: ../../../api/Cake.Issues/IIssue/18537A3D -[Priority]: ../../../api/Cake.Issues/IIssue/BFEFFBB1 -[PriorityName]: ../../../api/Cake.Issues/IIssue/05A39052 -[Rule]: ../../../api/Cake.Issues/IIssue/C8BCE21E -[RuleUrl]: ../../../api/Cake.Issues/IIssue/48A6F355 +[MsBuildXmlFileLoggerFormat]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/051D7B6E [IssuePriority.Warning]: ../../../api/Cake.Issues/IssuePriority/7A0CE07F From 1b48a1fbb4bd48cc8b65cf7299ab29f00785b608 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Sun, 30 Sep 2018 14:48:53 +0200 Subject: [PATCH 12/18] Add note about addin pinning --- examples.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/examples.md b/examples.md index 7513781..98d2c63 100644 --- a/examples.md +++ b/examples.md @@ -19,6 +19,13 @@ In order to use the above logger, the following line will download and install t #tool "nuget:?package=MSBuild.Extension.Pack" ``` +:::{.alert .alert-warning} +Please note that you always should pin addins and tools to a specific version to make sure your builds are deterministic and +won't break due to updates to one of the packages. + +See [pinning addin versions](https://cakebuild.net/docs/tutorials/pinning-cake-version#pinning-addin-version) for details. +::: + We need some global variables: ```csharp From b632bc593535fd0c8e11a82ca2abd1dec116fca8 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Wed, 5 Jun 2019 19:54:15 +0200 Subject: [PATCH 13/18] Add binary log file format to supported formats of MsBuild issue provider --- features.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/features.md b/features.md index 7a17354..db95595 100644 --- a/features.md +++ b/features.md @@ -13,6 +13,7 @@ The [Cake.Issues.MsBuild addin] provides the following features. # Supported log file formats +* [MsBuildBinaryLogFileFormat] alias for reading issues from binary log files. * [MsBuildXmlFileLoggerFormat] alias for reading issues from log files created by [MSBuild Extension Pack XmlFileLogger]. # Supported comment formats @@ -42,5 +43,6 @@ The [Cake.Issues.MsBuild addin] provides the following features. [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 [MsBuildAddRuleUrlResolver]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/93C21487 +[MsBuildBinaryLogFileFormat]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/AD50C7E1 [MsBuildXmlFileLoggerFormat]: ../../../api/Cake.Issues.MsBuild/MsBuildIssuesAliases/051D7B6E [IssuePriority.Warning]: ../../../api/Cake.Issues/IssuePriority/7A0CE07F From ab5e4badfd7bcf24a9ea8d59b5daccd61ae9c949 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Thu, 15 Aug 2019 17:41:01 +0200 Subject: [PATCH 14/18] Move documentation to docs folder --- examples.md => docs/examples.md | 0 features.md => docs/features.md | 0 index.cshtml => docs/index.cshtml | 0 requirements.md => docs/requirements.md | 0 4 files changed, 0 insertions(+), 0 deletions(-) rename examples.md => docs/examples.md (100%) rename features.md => docs/features.md (100%) rename index.cshtml => docs/index.cshtml (100%) rename requirements.md => docs/requirements.md (100%) diff --git a/examples.md b/docs/examples.md similarity index 100% rename from examples.md rename to docs/examples.md diff --git a/features.md b/docs/features.md similarity index 100% rename from features.md rename to docs/features.md diff --git a/index.cshtml b/docs/index.cshtml similarity index 100% rename from index.cshtml rename to docs/index.cshtml diff --git a/requirements.md b/docs/requirements.md similarity index 100% rename from requirements.md rename to docs/requirements.md From 4918e7834aa676099694c0233f6f1298b2dc8563 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Thu, 15 Aug 2019 17:43:19 +0200 Subject: [PATCH 15/18] Disable documentation generation --- setup.cake | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.cake b/setup.cake index 74b60e2..ad52bcb 100644 --- a/setup.cake +++ b/setup.cake @@ -10,6 +10,7 @@ BuildParameters.SetParameters( repositoryOwner: "cake-contrib", repositoryName: "Cake.Issues.MsBuild", appVeyorAccountName: "cakecontrib", + shouldGenerateDocumentation: false, shouldRunCodecov: false); BuildParameters.PrintParameters(Context); From 1699d529f28306da0aae63d9cd7533dbdd944e2d Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Fri, 16 Aug 2019 17:44:38 +0200 Subject: [PATCH 16/18] Fix documentation --- docs/examples.md | 31 +++++++++++++++---------------- docs/features.md | 2 +- docs/requirements.md | 2 +- 3 files changed, 17 insertions(+), 18 deletions(-) diff --git a/docs/examples.md b/docs/examples.md index 98d2c63..4003e87 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -44,9 +44,7 @@ Task("Build-Solution").Does(() => .WithLogger( Context.Tools.Resolve("MSBuild.ExtensionPack.Loggers.dll").FullPath, "XmlFileLogger", - string.Format( - "logfile=\"{0}\";verbosity=Detailed;encoding=UTF-8", - logPath) + $"logfile=\"{logPath}\";verbosity=Detailed;encoding=UTF-8" ); MSBuild(repoRootPath.CombineWithFilePath("MySolution.sln"), settings); @@ -58,19 +56,20 @@ The following example reads issues reported as MsBuild warnings by the `XmlFileL class from [MSBuild Extension Pack]: ```csharp -Task("Analyze-Log") -.IsDependentOn("Build-Solution") -.Does(() => -{ - // Read Issues. - var issues = ReadIssues( - MsBuildIssuesFromFilePath( - logPath, - MsBuildXmlFileLoggerFormat), - repoRootFolder); +Task("Read-Issues") + .IsDependentOn("Build-Solution") + .Does(() => + { + // Read Issues. + var issues = + ReadIssues( + MsBuildIssuesFromFilePath( + logPath, + MsBuildXmlFileLoggerFormat), + repoRootFolder); - Information("{0} issues are found.", issues.Count()); -}); + Information("{0} issues are found.", issues.Count()); + }); ``` -[MSBuild Extension Pack]: http://www.msbuildextensionpack.com/ \ No newline at end of file +[MSBuild Extension Pack]: http://www.msbuildextensionpack.com/ diff --git a/docs/features.md b/docs/features.md index db95595..78f695d 100644 --- a/docs/features.md +++ b/docs/features.md @@ -36,7 +36,7 @@ The [Cake.Issues.MsBuild addin] provides the following features. | | `IIssue.Line` | | | | `IIssue.Message` | | | | `IIssue.Priority` | Always [IssuePriority.Warning] | -| | `IIssue.PriorityName` | Always [IssuePriority.Warning] | +| | `IIssue.PriorityName` | Always `Warning` | | | `IIssue.Rule` | | | | `IIssue.RuleUrl` | For code analysis (`CA*`) and StyleCop (`SA*`) warnings. Support for additional rules can be added through a custom [MsBuildAddRuleUrlResolver] | diff --git a/docs/requirements.md b/docs/requirements.md index c8046f4..bc25ea6 100644 --- a/docs/requirements.md +++ b/docs/requirements.md @@ -6,4 +6,4 @@ Description: Requirements for the Cake.Issues.MsBuild addin. The requirements for using the [Cake.Issues.MsBuild addin] are listed in the [release notes] for any specific version. [Cake.Issues.MsBuild addin]: https://www.nuget.org/packages/Cake.Issues.MsBuild -[release notes]: release-notes \ No newline at end of file +[release notes]: release-notes From 1f8d21cac4ee0c370ea1dfe4ccf6c07cf5b96029 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Wed, 21 Aug 2019 00:13:51 +0200 Subject: [PATCH 17/18] (GH-120) Make issue provider type name available on issue provider --- .../MsBuildIssuesAliases.IssueProvider.cs | 2 +- src/Cake.Issues.MsBuild/MsBuildIssuesProvider.cs | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.IssueProvider.cs b/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.IssueProvider.cs index 2dfae47..4209fc4 100644 --- a/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.IssueProvider.cs +++ b/src/Cake.Issues.MsBuild/MsBuildIssuesAliases.IssueProvider.cs @@ -22,7 +22,7 @@ public static string MsBuildIssuesProviderTypeName( { context.NotNull(nameof(context)); - return typeof(MsBuildIssuesProvider).FullName; + return MsBuildIssuesProvider.ProviderTypeName; } /// diff --git a/src/Cake.Issues.MsBuild/MsBuildIssuesProvider.cs b/src/Cake.Issues.MsBuild/MsBuildIssuesProvider.cs index eba62eb..7001bf2 100644 --- a/src/Cake.Issues.MsBuild/MsBuildIssuesProvider.cs +++ b/src/Cake.Issues.MsBuild/MsBuildIssuesProvider.cs @@ -17,6 +17,12 @@ public MsBuildIssuesProvider(ICakeLog log, MsBuildIssuesSettings settings) { } + /// + /// Gets the name of the MsBuild issue provider. + /// This name can be used to identify issues based on the property. + /// + public static string ProviderTypeName => typeof(MsBuildIssuesProvider).FullName; + /// public override string ProviderName => "MSBuild"; } From de4c182073f12076a835cde97ff3536870914f91 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Thu, 22 Aug 2019 21:23:20 +0200 Subject: [PATCH 18/18] Update release notes link --- nuspec/nuget/Cake.Issues.MsBuild.nuspec | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nuspec/nuget/Cake.Issues.MsBuild.nuspec b/nuspec/nuget/Cake.Issues.MsBuild.nuspec index 4cf8965..392d10a 100644 --- a/nuspec/nuget/Cake.Issues.MsBuild.nuspec +++ b/nuspec/nuget/Cake.Issues.MsBuild.nuspec @@ -24,7 +24,7 @@ See the Project Site for an overview of the whole ecosystem of addins for workin Copyright © BBT Software AG and contributors Cake Script Cake-Issues Cake-IssueProvider CodeAnalysis Linting MsBuild - https://github.com/cake-contrib/Cake.Issues.MsBuild/releases/tag/0.7.1 + https://github.com/cake-contrib/Cake.Issues.MsBuild/releases/tag/0.7.2