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
Add Automatic-Module-Name to JAR manifest #1438
Conversation
This change breaks the javadoc but I am not sure why. |
Even with the all of our jars having their own name the javadoc plugin is still failing. It looks like an open bug with the plugin: https://issues.apache.org/jira/browse/MJAVADOC-609 |
The linked javadoc bug is fixed. It may be possible to get this working now. |
Thanks for the heads up. I will have to keep an eye out for version 3.2.0 |
Ooops. I thought it was released already. |
@milleruntime maven-javadoc-plugin-3.2.0 was released yesterday. We can probably make the automatic module names happen now. At least, we can resume the progress. 😺 |
* Add Java 9 module name to maven plugin config
58e4238
to
3a6ad11
Compare
This is passing with the latest version of the javadoc plugin. I believe the question is whether or not we still want to implement these names, given that there was very little response to my probe of our dependencies (see #1434). I still think there is value in providing the automatic names to downstream projects. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aside from the test module name, I think this is okay.
(Also, I think it might be possible to derive the property from the artifactId, so we have less config in each pom, but that can be follow-on.... once I figure out how to do it. 😺)
Seems like the new javadoc plugin is broken... it won't let you have a |
There is an open issue that gives the same error: https://issues.apache.org/jira/browse/MJAVADOC-614 |
I wonder if this is a legit javadoc bug (on our part)... it kinda seems right to error out like this... it doesn't make sense to have a document in a non-existent package. Although it's clear that this is an attempt to document the entire set of subpackages, aside from naming convention, there's no connection between a package and its subpackages, so it makes sense that there's an error here... we're effectively documenting nothingness. Perhaps it would be better to document this elsewhere, or to create a dummy class in the package to avoid the error. It is weird, though, that this would only be triggered when automatic module names are used... it works otherwise. |
@milleruntime What's the status of this PR? |
We were waiting for the maven javadoc plugin fix but then the new version 3.2.0 was still having issues. It looks like there may be a fix last year in apache/maven-javadoc-plugin#30 but there hasn't been a release for it yet. |
Superseded by #2498 |
This will assist downstream projects with Java Modules. See #1434