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

[java] Specify Java version for maven-javadoc-plugin (fixes Java 11 error) #6260

Closed

Conversation

aloisklink
Copy link
Contributor

Specify the Java version to maven-javadoc-plugin. This is essentially just adding the <source>java.version</source> tag to pom.mustache files, e.g.:

<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.1</version>
<configuration>
  <doclint>none</doclint>
  {{#supportJava6}}
    <source>1.6</source>
  {{/supportJava6}}
  {{^supportJava6}}
  {{#java8}}
    <source>1.8</source>
  {{/java8}}
  {{^java8}}
    <source>1.7</source>
  {{/java8}}
  {{/supportJava6}}

for almost all clients, except java/rest-assured, which I hard-coded to <source>1.8</source>, since it only supports Java 8.

This fixes the same issue as #5361 when trying to use generated clients in Java 11:

An error has occurred in Javadoc report generation: [ERROR] Exit code: 1 - javadoc: error - The code being documented uses modules but the packages defined in https://docs.oracle.com/javase/8/docs/api/ are in the unnamed module error that happens when using Java 11

Additionally, I've fixed the broken integration tests in java/retrofit2-play24 and java/jersey2-java6. java/feign tests are also failing, but that should be fixed by the already pending pull request #5786.

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
    • No breaking changes (as far as I'm aware)
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

on-behalf-of: @nqminds <info@nquiringminds.com>
We add the following <source> tag to the <configuration> of
maven-javadoc-plugin for most pom.mustache files that use it.
This tells javadoc which version of java the compiler used.

This fixes the following error when running Java 11:
[ERROR] Exit code: 1 - javadoc: error - The code being documented uses
modules but the packages defined in
https://docs.oracle.com/javase/8/docs/api/ are in the unnamed module

Additionally, we also add maven-compiler-plugin to jersey2/pom.mustache
to specify that the source code is Java 6/7/8.

on-behalf-of: @nqminds <info@nquiringminds.com>
Pull-request OpenAPITools#4666 changed jersey generation, but didn't update the
test samples Tests now succeed.

on-behalf-of: @nqminds <info@nquiringminds.com>
Running mvn integration-test failed in
samples/client/petstore/java/retrofit2-play24

This merges pull requests OpenAPITools#1735 and OpenAPITools#5527 into
retrofit2-play24.

Also removes the jackson-databind-version field,
since it should always be the same as jackson-version,
and updates build.gradle/build.sbt

on-behalf-of: @nqminds <info@nquiringminds.com>
@auto-labeler
Copy link

auto-labeler bot commented May 11, 2020

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@aloisklink aloisklink changed the title Specify Java version for maven-javadoc-plugin (fixes Java 11 error) [java] Specify Java version for maven-javadoc-plugin (fixes Java 11 error) May 12, 2020
@wing328
Copy link
Member

wing328 commented May 18, 2020

@aloisklink thanks for the PR. Can you please resolve the merge conflicts when you've time?

Fixes merge conflicts due to Jackson Databind version increase OpenAPITools#6328
@aloisklink
Copy link
Contributor Author

Hi @wing328, cheers letting me know about the merge conflicts! I swear Github used to send out alerts if there was a merge conflict, but maybe I was imagining it.

@wing328
Copy link
Member

wing328 commented Jun 16, 2020

@aloisklink thanks for the PR.

Merged via #6679 (with merge conflicts resolved)

@wing328 wing328 closed this Jun 16, 2020
@aloisklink aloisklink deleted the fix-javadoc-source-pom-xml branch June 16, 2020 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants