From 1fbfc54f420acc93d8ab396fe9fe5f1f5cb99d86 Mon Sep 17 00:00:00 2001 From: Bertrand Giot Date: Wed, 12 Dec 2018 15:21:00 +0100 Subject: [PATCH 1/4] Add support of --warningsaserrors build parameter --- .../Build/DocFxBuildRunnerTests.cs | 17 +++++++++++++++++ src/Cake.DocFx/Build/DocFxBuildRunner.cs | 5 +++++ src/Cake.DocFx/Build/DocFxBuildSettings.cs | 5 +++++ 3 files changed, 27 insertions(+) diff --git a/src/Cake.DocFx.Tests/Build/DocFxBuildRunnerTests.cs b/src/Cake.DocFx.Tests/Build/DocFxBuildRunnerTests.cs index 1683407..bd75303 100644 --- a/src/Cake.DocFx.Tests/Build/DocFxBuildRunnerTests.cs +++ b/src/Cake.DocFx.Tests/Build/DocFxBuildRunnerTests.cs @@ -119,6 +119,23 @@ public void Should_Add_Force_To_Arguments_If_True() // Then Assert.Equal("build --force", result.Args); } + + + [Fact] + public void Should_Add_WarningsAsErrors_To_Arguments_If_True() + { + // Given + var fixture = new DocFxBuildRunnerFixture + { + Settings = { WarningsAsErrors = true } + }; + + // When + var result = fixture.Run(); + + // Then + Assert.Equal("build --warningsAsErrors", result.Args); + } } } } diff --git a/src/Cake.DocFx/Build/DocFxBuildRunner.cs b/src/Cake.DocFx/Build/DocFxBuildRunner.cs index 5665058..c935303 100644 --- a/src/Cake.DocFx/Build/DocFxBuildRunner.cs +++ b/src/Cake.DocFx/Build/DocFxBuildRunner.cs @@ -75,6 +75,11 @@ private ProcessArgumentBuilder GetArguments(FilePath configFile, DocFxBuildSetti builder.Append("--force"); } + if (settings.WarningsAsErrors) + { + builder.Append("--warningsAsErrors"); + } + return builder; } } diff --git a/src/Cake.DocFx/Build/DocFxBuildSettings.cs b/src/Cake.DocFx/Build/DocFxBuildSettings.cs index c8f698b..d5b833a 100644 --- a/src/Cake.DocFx/Build/DocFxBuildSettings.cs +++ b/src/Cake.DocFx/Build/DocFxBuildSettings.cs @@ -50,5 +50,10 @@ public class DocFxBuildSettings : ToolSettings /// Gets or sets a value indicating whether all the documentation is re-build. /// public bool Force { get; set; } + + /// + /// Gets or sets a value indicating whether all warnings must be seen as errors + /// + public bool WarningsAsErrors { get; set; } } } \ No newline at end of file From 1277c9f0524f7528dbc149d6a113ddbf4b487687 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Thu, 1 Nov 2018 13:44:45 +0100 Subject: [PATCH 2/4] Use JsDelivr for icon --- nuspec/nuget/Cake.DocFx.nuspec | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nuspec/nuget/Cake.DocFx.nuspec b/nuspec/nuget/Cake.DocFx.nuspec index 294bb7b..c708e2f 100644 --- a/nuspec/nuget/Cake.DocFx.nuspec +++ b/nuspec/nuget/Cake.DocFx.nuspec @@ -10,7 +10,7 @@ The DocFx Addin for Cake allows you to generated API documentation directly from .NET source code. https://github.com/cake-contrib/Cake.DocFx/blob/develop/LICENSE https://github.com/cake-contrib/Cake.DocFx - https://cdn.rawgit.com/cake-contrib/graphics/a5cf0f881c390650144b2243ae551d5b9f836196/png/cake-contrib-medium.png + https://cdn.jsdelivr.net/gh/cake-contrib/graphics@a5cf0f881c390650144b2243ae551d5b9f836196/png/cake-contrib-medium.png false Copyright (c) Cake Contributions 2016 - Present Cake Script DocFx From fd4520503cac1bda3fd6ee5e98486a6d3a7a553e Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Mon, 17 Dec 2018 21:32:53 +0100 Subject: [PATCH 3/4] Update release notes link --- nuspec/nuget/Cake.DocFx.nuspec | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/nuspec/nuget/Cake.DocFx.nuspec b/nuspec/nuget/Cake.DocFx.nuspec index c708e2f..ea1425c 100644 --- a/nuspec/nuget/Cake.DocFx.nuspec +++ b/nuspec/nuget/Cake.DocFx.nuspec @@ -14,7 +14,7 @@ false Copyright (c) Cake Contributions 2016 - Present Cake Script DocFx - https://github.com/cake-contrib/Cake.DocFx/releases/tag/0.10.0 + https://github.com/cake-contrib/Cake.DocFx/releases/tag/0.11.0 From 56e58744193c9d6970b5ec0cb017254113ee9758 Mon Sep 17 00:00:00 2001 From: Pascal Berger Date: Mon, 17 Dec 2018 21:35:16 +0100 Subject: [PATCH 4/4] Ignore task files generated during build --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index a9e78cf..3242490 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +# Build process output +docs/input/tasks/ + ## Ignore Visual Studio temporary files, build results, and ## files generated by popular Visual Studio add-ons. ##