Skip javadoc in starter and create empty -javadoc jar instead

qaware · May 5, 2021 · 24dfa13 · 24dfa13
1 parent 48a3a64
commit 24dfa13
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 37 deletions.
diff --git a/openapi-generator-for-spring-starter/javadoc/README.txt b/openapi-generator-for-spring-starter/javadoc/README.txt
@@ -0,0 +1,2 @@
+This module is a Spring Boot starter, it just depends on useful
+modules so that a user needs only the starter to get started.
diff --git a/openapi-generator-for-spring-starter/pom.xml b/openapi-generator-for-spring-starter/pom.xml
@@ -36,16 +36,44 @@
         </dependency>
     </dependencies>
 
-    <build>
-        <plugins>
-            <plugin>
-                <artifactId>maven-javadoc-plugin</artifactId>
-                <configuration>
-                    <!-- See https://issues.apache.org/jira/browse/MJAVADOC-274 -->
-                    <failOnError>false</failOnError>
-                    <quiet>true</quiet>
-                </configuration>
-            </plugin>
-        </plugins>
-    </build>
+
+    <profiles>
+        <profile>
+            <id>deploy</id>
+            <activation>
+                <property>
+                    <name>deploy</name>
+                </property>
+            </activation>
+            <properties>
+                <maven.javadoc.skip>true</maven.javadoc.skip>
+            </properties>
+            <build>
+                <plugins>
+                    <plugin>
+                        <!--
+                        As SonaType requires a -javadoc.jar to be present for deployment,
+                        we fake an empty one here.
+                        See: https://vzurczak.wordpress.com/2014/08/01/generate-an-empty-javadoc-jar-file/
+                        -->
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-jar-plugin</artifactId>
+                        <executions>
+                            <execution>
+                                <id>empty-javadoc-jar</id>
+                                <phase>package</phase>
+                                <goals>
+                                    <goal>jar</goal>
+                                </goals>
+                                <configuration>
+                                    <classifier>javadoc</classifier>
+                                    <classesDirectory>${basedir}/javadoc</classesDirectory>
+                                </configuration>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+    </profiles>
 </project>
diff --git a/...pring-starter/src/main/java/de/qaware/openapigeneratorforspring/starter/package-info.java b/...pring-starter/src/main/java/de/qaware/openapigeneratorforspring/starter/package-info.java
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		This module is a Spring Boot starter, it just depends on useful
		modules so that a user needs only the starter to get started.