adobe/aem-guides-wknd

Uncomment the package-info.java workaround when OpenJDK has fix

SachinMali opened this issue · 0 comments

Upon opening PRs to main the Maven CI github action fails with the below error

Error: Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.9.1:jar (attach-javadocs) on project aem-guides-wknd.core: MavenReportException: Error while creating archive:
Error: Exit code: 1 - /home/runner/work/aem-guides-wknd/aem-guides-wknd/core/src/main/java/com/adobe/aem/guides/wknd/core/models/package-info.java:16: error: unknown tag: org.osgi.annotation.versioning.Version
Error: @org.osgi.annotation.versioning.Version("2.1.0")
Error: ^
Error:
Error: Command line was: /opt/hostedtoolcache/jdk/11.0.17/x64/bin/javadoc @options @packages
Error:
Error: Refer to the generated Javadoc files in '/home/runner/work/aem-guides-wknd/aem-guides-wknd/core/target/apidocs' dir.
Error:

Root Cause is Javadoc does not handle package annotations correctly on package-info.java

To fix above issue PR openjdk/jdk11u-dev#1475 is raised but not merged and released..

Work Around is to skip the Java Version by adding empty JavaDoc block like

/** */@org.osgi.annotation.versioning.Version("2.1.0")
package com.adobe.aem.guides.wknd.core.models;