Merge branch 'release/0.11.0'

cake-contrib · Dec 17, 2018 · 6612712 · 6612712
2 parents b73d99b + 56e5874
commit 6612712
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 2 deletions.
diff --git 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.
 ##

diff --git a/nuspec/nuget/Cake.DocFx.nuspec b/nuspec/nuget/Cake.DocFx.nuspec
@@ -10,11 +10,11 @@
     <summary>The DocFx Addin for Cake allows you to generated API documentation directly from .NET source code.</summary>
     <licenseUrl>https://github.com/cake-contrib/Cake.DocFx/blob/develop/LICENSE</licenseUrl>
     <projectUrl>https://github.com/cake-contrib/Cake.DocFx</projectUrl>
-    <iconUrl>https://cdn.rawgit.com/cake-contrib/graphics/a5cf0f881c390650144b2243ae551d5b9f836196/png/cake-contrib-medium.png</iconUrl>
+    <iconUrl>https://cdn.jsdelivr.net/gh/cake-contrib/graphics@a5cf0f881c390650144b2243ae551d5b9f836196/png/cake-contrib-medium.png</iconUrl>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <copyright>Copyright (c) Cake Contributions 2016 - Present</copyright>
     <tags>Cake Script DocFx</tags>
-    <releaseNotes>https://github.com/cake-contrib/Cake.DocFx/releases/tag/0.10.0</releaseNotes>
+    <releaseNotes>https://github.com/cake-contrib/Cake.DocFx/releases/tag/0.11.0</releaseNotes>
   </metadata>
   <files>
     <file src="netstandard2.0\Cake.DocFx.dll" target="lib\netstandard2.0" />

diff --git 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
@@ -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
@@ -50,5 +50,10 @@ public class DocFxBuildSettings : ToolSettings
         /// Gets or sets a value indicating whether all the documentation is re-build.
         /// </summary>
         public bool Force { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether all warnings must be seen as errors
+        /// </summary>
+        public bool WarningsAsErrors { get; set; }
     }
 }