-
Notifications
You must be signed in to change notification settings - Fork 909
Fix javadoc to make it build with JDK 17 #3415
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
Conversation
pom.xml
Outdated
<executions> | ||
<execution> | ||
<id>generate-javadocs</id> | ||
<phase>package</phase> | ||
<goals> | ||
<goal>javadoc</goal> | ||
</goals> | ||
<configuration> | ||
<detectJavaApiLink>false</detectJavaApiLink> | ||
<source>8</source> | ||
<notree>true</notree> | ||
<includeDependencySources>false</includeDependencySources> | ||
<doclint>none</doclint> | ||
</configuration> | ||
</execution> | ||
</executions> | ||
</plugin> |
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.
This will likely increase our build time because we are generating Javadocs now as part of the build.
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.
Build took at least 15 mins longer after the change. We probably should not build it then or at least disable it for service modules
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.
- Are we going to use these Java Docs in https://github.com/aws/aws-sdk-java-v2/blob/master/buildspecs/release-javadoc.yml ?
- Why didn't we consider adding it as parallel step , since we have failures due to intermittent test failures.
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.
Nope, they are part of the build process. I tested it and it did not increase the build time w/ service modules disabled.
I considered creating another codebuild job to run the same command as release-javadoc, but the whole job can take more than one hour and it works with the largest instance, so I went with this approach.
Kudos, SonarCloud Quality Gate passed! |
Motivation and Context
Fix javadoc so that we can use JDK 17 to generate Javadoc site
Modifications
Testing
Tested locally with JDK17 as well as CodeBuild job