Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A check to detect javadoc plugin malfunction #661

Closed
suztomo opened this issue Sep 25, 2023 · 2 comments · Fixed by #662
Closed

A check to detect javadoc plugin malfunction #661

suztomo opened this issue Sep 25, 2023 · 2 comments · Fixed by #662
Assignees
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@suztomo
Copy link
Member

suztomo commented Sep 25, 2023

Let's implement a check to detect javadoc plugin malfunction. We already have test, lint, and clirr jobs in https://github.com/googleapis/java-shared-config/blob/main/.github/workflows/downstream-maven-plugins.yaml.

@alicejli observed the following error:

Execution default-cli of goal org.apache.maven.plugins:maven-javadoc-plugin:3.6.0:aggregate failed: If a non-null excludes list is given, all elements must be non-null -> [Help 1]
@JoeWang1127 JoeWang1127 added priority: p2 Moderately-important priority. Fix may not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. labels Sep 25, 2023
@alicejli
Copy link
Contributor

alicejli commented Oct 4, 2023

The failure occurs when using the doclet to create the javadocs.

To get a local copy of the doclet, clone https://github.com/googleapis/java-docfx-doclet/tree/main/third_party/docfx-doclet-143274 and checkout 1.9.0 (this is the version of the doclet that Kokoro is using).

Run mvn compile && mvn package and get the path to the generated jar with dependencies. It will look something like this:

/home/alicejli/testRepos/java-docfx-doclet/third_party/docfx-doclet-143274/target/docfx-doclet-1.0-SNAPSHOT-jar-with-dependencies.jar

Then to replicate the javadoc failure, checkout java-bigtable and run the following (be sure to replace the {docletPath} with the path from above):

 mvn clean -B -ntp               -P docFX               -DdocletPath="${docletPath}"               -Dclirr.skip=true               -Denforcer.skip=true               -Dorg.slf4j.simpleLogger.showDateTime=true -Dorg.slf4j.simpleLogger.dateTimeFormat=HH:mm:ss:SSS               -Dcheckstyle.skip=true               -Dflatten.skip=true               -Danimal.sniffer.skip=true               javadoc:aggregate

@alicejli
Copy link
Contributor

alicejli commented Oct 4, 2023

Fixed with #662

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants