Fail CI step/workflow on javadoc warnings. #1715 (#1719)

Signed-off-by: Quan Nguyen <quan.nguyen@hedera.com>
hashgraph · Jul 1, 2021 · 1bf85cf · 1bf85cf
1 parent a389736
commit 1bf85cf
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/pom.xml b/pom.xml
@@ -152,6 +152,7 @@
     <maven-surefire.version>2.22.2</maven-surefire.version>
     <maven-dependency.version>3.1.1</maven-dependency.version>
     <maven-versions.version>2.8.1</maven-versions.version>
+    <maven-javadoc.version>3.3.0</maven-javadoc.version>
     <commons-io.version>2.7</commons-io.version>
 
     <!-- Dependency properties -->
@@ -224,6 +225,21 @@ ${git.signoff}
           </preparationGoals>
         </configuration>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>${maven-javadoc.version}</version>
+        <configuration>
+          <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
+          <failOnWarnings>true</failOnWarnings>
+        </configuration>
+        <executions>
+          <execution>
+            <phase>install</phase>
+            <id>generate-javadocs</id>
+          </execution>
+        </executions>
+      </plugin>
       <plugin>
         <groupId>org.codehaus.mojo</groupId>
         <artifactId>exec-maven-plugin</artifactId>
@@ -523,8 +539,10 @@ ${git.signoff}
           <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-javadoc-plugin</artifactId>
+            <version>${maven-javadoc.version}</version>
             <configuration>
               <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable>
+              <failOnWarnings>true</failOnWarnings>
             </configuration>
             <executions>
               <execution>