Javadoc not generated during jsii-pacmak run

[stefanfreitag]

❓ Setting of JAVA_HOME required for generating Java packages?

Affected Languages

• TypeScript or Javascript
• Python
• Java
• .NET (C#, F#, ...)

General Information

• JSII Version: 1.12.0 (build 5ddc9f2), typescript 3.9.7
• Platform: Linux ThinkPad-E570 5.4.0-42-generic Rely ARGV to jsii kernel upon initialization #46-Ubuntu SMP x86_64 x86_64 x86_64 GNU/Linux

The Question

I have setup a project generating Javascript, Python, DotNet, and Java packages. When trying to publish the Java packages I was informed by the remote servers that the javadoc files (jar, md5, sha1) were missing.

The project folder dist/java/io/github/stefanfreitag/cdkBudgetNotifier/0.2.0 contained

-rw-rw-r-- 1 stefan stefan 33697 Aug 28 21:47 cdkBudgetNotifier-0.2.0.jar
-rw-rw-r-- 1 stefan stefan    32 Aug 28 21:47 cdkBudgetNotifier-0.2.0.jar.md5
-rw-rw-r-- 1 stefan stefan    40 Aug 28 21:47 cdkBudgetNotifier-0.2.0.jar.sha1
-rw-rw-r-- 1 stefan stefan  5440 Aug 28 21:47 cdkBudgetNotifier-0.2.0.pom
-rw-rw-r-- 1 stefan stefan    32 Aug 28 21:47 cdkBudgetNotifier-0.2.0.pom.md5
-rw-rw-r-- 1 stefan stefan    40 Aug 28 21:47 cdkBudgetNotifier-0.2.0.pom.sha1
-rw-rw-r-- 1 stefan stefan 28299 Aug 28 21:47 cdkBudgetNotifier-0.2.0-sources.jar
-rw-rw-r-- 1 stefan stefan    32 Aug 28 21:47 cdkBudgetNotifier-0.2.0-sources.jar.md5
-rw-rw-r-- 1 stefan stefan    40 Aug 28 21:47 cdkBudgetNotifier-0.2.0-sources.jar.sha1

So, no javadoc files, but also no error reported by jsii-pacmak.

By changing the behavior of jsii-pacmak [1] during the java target execution I was able to get some useful output:

STDOUT> [INFO] Downloaded from central: https://repo.maven.apache.org/maven2/org/codehaus/plexus/plexus-utils/3.0.24/plexus-utils-3.0.24.jar (247 kB at 98 kB/s)
#STDOUT> [INFO] Downloaded from central: https://repo.maven.apache.org/maven2/org/apache/commons/commons-compress/1.16.1/commons-compress-1.16.1.jar (560 kB at 220 kB/s)
#STDOUT> [INFO] ------------------------------------------------------------------------
#STDOUT> [INFO] Reactor Summary:
#STDOUT> [INFO] 
#STDOUT> [INFO] io.github.stefanfreitag:cdkBudgetNotifier 0.2.0 .... FAILURE [ 37.646 s]
#STDOUT> [INFO] aggregatepom 1.0.0 ................................. SKIPPED
#STDOUT> [INFO] ------------------------------------------------------------------------
#STDOUT> [INFO] BUILD FAILURE
#STDOUT> [INFO] ------------------------------------------------------------------------
#STDOUT> [INFO] Total time:  37.728 s
#STDOUT> [INFO] Finished at: 2020-08-28T22:02:07+02:00
#STDOUT> [INFO] ------------------------------------------------------------------------
#STDOUT> [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.1.1:jar (attach-javadocs) on project cdkBudgetNotifier: MavenReportException: Error while generating Javadoc: Unable to find javadoc command: The environment variable JAVA_HOME is not correctly set. -> [Help 1]
#STDOUT> [ERROR] 
#STDOUT> [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
#STDOUT> [ERROR] Re-run Maven using the -X switch to enable full debug logging.
#STDOUT> [ERROR] 
#STDOUT> [ERROR] For more information about the errors and possible solutions, please read the following articles:
#STDOUT> [ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
#STDOUT> 

and after setting the JAVA_HOME environment variable jsii-pacmak generated the javadoc files.

As the error message about JAVA_HOME is silenced, would it make sense to mention it explicitly in the documentation?

[1] In targets/java.ts I changed a failOnError setting from false to true.