Set Maven Javadoc Plugin release version to 11
Description
Environment
Activity
Philip Smart April 22, 2020 at 9:56 AM
Resolved in commit: de0479a5b9e6c704075426b71195ec3f39cbc468
Philip Smart April 21, 2020 at 3:52 PM
Replaced the maven compiler source and target versions with the maven compiler release version (available from JDK 9)
Philip Smart April 8, 2020 at 1:39 PM
Yes, that makes sense.
In which case I will make the patched version more permanent within the project (git and nexus). Once that is done, we could move the parent project to 3.2.0-PATCHED (or similar) and remove the downgrading of it from relevant projects (IdP and opensaml I think).
I think I will wait to make this change, so we can make both changes together.
Scott Cantor April 8, 2020 at 1:22 PM
I really think using the patched/forked copy at this point is saving us work, not adding to it. If that version were, for example, to fix all our issues at present, there's no obvious reason we would move off it in the future unless something else breaks anyway.
Philip Smart April 8, 2020 at 1:16 PM
Yes, we probably still need to hold back the javadoc plugin to 3.0.1, otherwise if we switch to 3.1.1 we get the issues shown in IDP-1531. If we switch to 3.2.0 we loose the API aggregate docs, see https://shibboleth.atlassian.net/browse/JPAR-161#icft=JPAR-161 - unless we use the patched 3.2.0 I have locally (which then fixes both of those issues).
Hopefully they fix the javadoc plugin by the time of next release (unlikely). Otherwise, even though we are in a slightly better place by fixing the release version to 11, we still need to possibly switch to the patched 3.2.0 and build under Java 12.0.1 or 13.
The standard Java 11 Doclet builds broken links for the HTML search box (see https://issues.shibboleth.net/jira/browse/JPAR-162). To fix this, Java 12.0.1 or 13 can be used to build the apidocs. However, when built with a different Java version, the links to the JavaSE APIs reflect that version e.g. Java 12.0.1 or 13.
To fix those references, the <release> version of the Java compiler can be set when building the site apidocs so the Javadoc references all point to the correct JavaSE APIs e.g. 11.
This can be set project wide on the maven javadoc plugin by including the release configuration parameter in the java-parent project.