-
Notifications
You must be signed in to change notification settings - Fork 728
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
Target Java 8 in maven-javadoc-plugin #1531
Conversation
To avoid errors related to modules. It only makes sense, since the library itself targets Java 8 anyway, and the library's javadoc already links to JDK 8's javadoc (not JDK 11's). The resulting javadoc does not seem to differ in any significant way; below is the result of a diff between the output with: * maven-javadoc-plugin 3.0.0 + <source>11</source> * maven-javadoc-plugin 3.4.1 + <release>8</release> ``` $ diff -I "Generated by javadoc" -r target/apidocs/ ~/tmp/github-api-apidocs-8 Binary files target/apidocs/member-search-index.zip and /home/yrodiere/tmp/github-api-apidocs-8/member-search-index.zip differ diff -I 'Generated by javadoc' -r target/apidocs/org/kohsuke/github/GHPersonSet.html /home/yrodiere/tmp/github-api-apidocs-8/org/kohsuke/github/GHPersonSet.html 276c276 < <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true#parallelStream()" title="class or interface in java.util" class="externalLink">parallelStream</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true#removeIf(java.util.function.Predicate)" title="class or interface in java.util" class="externalLink">removeIf</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true#stream()" title="class or interface in java.util" class="externalLink">stream</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true#toArray(java.util.function.IntFunction)" title="class or interface in java.util" class="externalLink">toArray</a></code></li> --- > <code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true#parallelStream()" title="class or interface in java.util" class="externalLink">parallelStream</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true#removeIf(java.util.function.Predicate)" title="class or interface in java.util" class="externalLink">removeIf</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true#stream()" title="class or interface in java.util" class="externalLink">stream</a></code></li> Binary files target/apidocs/package-search-index.zip and /home/yrodiere/tmp/github-api-apidocs-8/package-search-index.zip differ Binary files target/apidocs/type-search-index.zip and /home/yrodiere/tmp/github-api-apidocs-8/type-search-index.zip differ ```
Codecov ReportBase: 79.27% // Head: 79.27% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## main #1531 +/- ##
=========================================
Coverage 79.27% 79.27%
Complexity 2137 2137
=========================================
Files 206 206
Lines 6562 6562
Branches 362 362
=========================================
Hits 5202 5202
Misses 1148 1148
Partials 212 212 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
It's strange, I thought I was seeing this even with the |
I was using JDK 11 since tests don't seem to pass with JDK 17. That being said, I just ran the build with I think the trick is using |
To avoid errors related to modules.
Fixes #1528
It only makes sense, since the library itself targets Java 8 anyway, and the library's javadoc already links to JDK 8's javadoc (not JDK 11's).
The resulting javadoc does not seem to differ in any significant way; below is the result of a diff between the output with:
<source>11</source>
<release>8</release>
Now, you will ask: what about when we drop support for JDK 8? Well, I don't have an answer for that, but I hope the problematic dependencies (those with split packages) will be gone by then. If not, I'd say that's a problem for another day.