8000 Merge #2962 · camunda/camunda@96b67b5 · GitHub
[go: up one dir, main page]
Skip to content

Commit 96b67b5

Browse files
zeebe-bors[bot]ChrisKujawa
zeebe-bors[bot]
and
ChrisKujawa
committed
Merge #2962
2962: Fix Javadoc generation r=saig0 a=Zelldon ## Description After migration to Java 11 the generation of JavaDoc failed on develop.The following error was printed: ```java [2019-08-09T16:16:31.038Z] [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:jar (default-cli) on project zeebe-build-tools: MavenReportException: Error while creating archive: [2019-08-09T16:16:31.038Z] [ERROR] Exit code: 1 - Picked up JAVA_TOOL_OPTIONS: -XX:+UseContainerSupport [2019-08-09T16:16:31.038Z] [ERROR] [2019-08-09T16:16:31.038Z] [ERROR] javadoc: error - The code being documented uses modules but the packages defined in http://docs.oracle.com/javase/7/docs/api/ are in the unnamed module. [2019-08-09T16:16:31.038Z] [ERROR] [2019-08-09T16:16:31.038Z] [ERROR] Command line was: /docker-java-home/bin/javadoc @options @packages [2019-08-09T16:16:31.038Z] [ERROR] [2019-08-09T16:16:31.038Z] [ERROR] Refer to the generated Javadoc files in '/home/jenkins/workspace/zeebe-io_zeebe_develop/build-tools/target/apidocs' dir. [2019-08-09T16:16:31.038Z] [ERROR] -> [Help 1] ``` Multiple things where problematic. As first we used an old java doc plugin, inherited by the camunda release parent and the java version was not set correctly. After fixing this, some other modules had still a problem with generating java doc. * `json-el`: * Scala currently do not support 100% Java 11. See: * https://docs.scala-lang.org/overviews/jdk-compatibility/overview.html * scala/scala-dev#559 * `gateway-protocol-impl` * is compiled with 8, but if we execute java doc with 11 we get the error that javax was not found. I will create an issue to investigate this. * `protocol-assert`: * generated code seems to have some problems with the javadoc. I create an issue for this. To verify the changes you can run: ```bash mvn -B -T1C generate-sources source:jar javadoc:jar clean verify -DskipTests ``` # Co-authored-by: Christopher Zell <zelldon91@googlemail.com>
2 parents da71537 + 58e4a34 commit 96b67b5

File tree

6 files changed

+42
-7
lines changed

6 files changed

+42
-7
lines changed

‎bom/pom.xml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
1+
<project xmlns="http://maven.apache.org/POM/4.0.0"
2+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
24

35
<modelVersion>4.0.0</modelVersion>
46
<name>Zeebe BOM</name>
@@ -14,7 +16,7 @@
1416
<artifactId>camunda-release-parent</artifactId>
1517
<version>3.7</version>
1618
<!-- do not remove empty tag - http://jira.codehaus.org/browse/MNG-4687 -->
17-
<relativePath />
19+
<relativePath/>
1820
</parent>
1921

2022
<properties>
@@ -26,6 +28,9 @@
2628
</nexus.release.repository>
2729

2830
<version.netty>4.1.38.Final</version.netty>
31+
32+
<version.java>11</version.java>
33+
<plugin.version.javadoc>3.1.1</plugin.version.javadoc>
2934
</properties>
3035

3136
<dependencyManagement>

‎build-tools/pom.xml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
1+
<project xmlns="http://maven.apache.org/POM/4.0.0"
2+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
24

35
<modelVersion>4.0.0</modelVersion>
46
<name>Zeebe Build Tools</name>
@@ -25,5 +27,4 @@
2527
<version>1.7.27</version>
2628
</dependency>
2729
</dependencies>
28-
2930
</project>

‎gateway-protocol-impl/pom.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
<version.java>8</version.java>
2626
<license.header>com/mycila/maven/plugin/license/templates/APACHE-2.txt</license.header>
2727
<proto.dir>${project.build.directory}/proto</proto.dir>
28+
<maven.javadoc.skip>true</maven.javadoc.skip>
2829
</properties>
2930

3031
<dependencies>

‎json-el/pom.xml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
1+
<project xmlns="http://maven.apache.org/POM/4.0.0"
2+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
24
<modelVersion>4.0.0</modelVersion>
35
<name>Zeebe Msgpack Json Expression Language</name>
46
<artifactId>zeebe-msgpack-json-el</artifactId>
@@ -11,6 +13,11 @@
1113
<relativePath>../parent</relativePath>
1214
</parent>
1315

16+
17+
<properties>
18+
<maven.javadoc.skip>true</maven.javadoc.skip>
19+
</properties>
20+
1421
<dependencies>
1522
<dependency>
1623
<groupId>io.zeebe</groupId>

‎parent/pom.xml

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@
2626

2727
<properties>
2828

29-
<version.java>11</version.java>
30-
3129
<!-- Zeebe Community License v1.0 header -->
3230
<license.header>${maven.multiModuleProjectDirectory}/parent/COPYING-HEADER.txt</license.header>
3331

@@ -564,6 +562,25 @@
564562
</configuration>
565563
</plugin>
566564

565+
<plugin>
566+
<groupId>org.apache.maven.plugins</groupId>
567+
<artifactId>maven-javadoc-plugin</artifactId>
568+
<version>${plugin.version.javadoc}</version>
569+
<configuration>
570+
<source>${version.java}</source>
571+
<quiet>true</quiet>
572+
<additionalOptions>-Xdoclint:none</additionalOptions>
573+
</configuration>
574+
<executions>
575+
<execution>
576+
<id>attach-javadocs</id>
577+
<goals>
578+
<goal>jar</goal>
579+
</goals>
580+
</execution>
581+
</executions>
582+
</plugin>
583+
567584
<!-- LICENSE PLUGIN -->
568585
<plugin>
569586
<groupId>com.mycila</groupId>

‎protocol-asserts/pom.xml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@
1414
<relativePath>../parent</relativePath>
1515
</parent>
1616

17+
<properties>
18+
<maven.javadoc.skip>true</maven.javadoc.skip>
19+
</properties>
20+
1721
<dependencies>
1822
<dependency>
1923
<groupId>io.zeebe</groupId>

0 commit comments

Comments
 (0)
0