Add Javadoc and sources (#119)

streamnative · Jan 30, 2024 · 95ffb86 · 95ffb86
1 parent 3ccfd49
commit 95ffb86
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 2 deletions.
diff --git a/etc/checkstyle.xml b/etc/checkstyle.xml
@@ -61,7 +61,8 @@
   <!-- Excludes all 'module-info.java' files              -->
   <!-- See https://checkstyle.org/config_filefilters.html -->
   <module name="BeforeExecutionExclusionFileFilter">
-    <property name="fileNamePattern" value="module\-info\.java$"/>
+    <property name="fileNamePattern"
+              value=".*[\\/]generated-sources[\\/].*$"/>
   </module>
 
   <!-- https://checkstyle.org/config_filters.html#SuppressionFilter -->

diff --git a/pom.xml b/pom.xml
@@ -207,7 +207,7 @@
                     </java>
                     <markdown>
                         <includes>
-                            <include>**/*.md</include>
+                            <include>**/README.md</include>
                         </includes>
                         <flexmark/>
                     </markdown>
@@ -349,6 +349,40 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.6.3</version>
+                <configuration>
+                    <doclint>none</doclint>
+                    <notimestamp>true</notimestamp>
+                    <sourceFileExcludes>
+                        <sourceFileExclude>**/generated-sources/*.java</sourceFileExclude>
+                    </sourceFileExcludes>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>javadoc</goal>
+                            <goal>jar</goal>
+                        </goals>
+                        <phase>verify</phase>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>3.3.0</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                        <phase>verify</phase>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <artifactId>maven-surefire-plugin</artifactId>
                 <version>${maven.surefire.plugin.version}</version>