Skip to content

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

Merged
merged 10 commits into from
Sep 13, 2022
Merged

Conversation

zoewangg
Copy link
Contributor

@zoewangg zoewangg commented Sep 7, 2022

Motivation and Context

Fix javadoc so that we can use JDK 17 to generate Javadoc site

Modifications

  • Fix broken Javadoc
  • Add generate-javadoc to the build process so that we can catch regressions
  • Update release Javadoc buildspec

Testing

Tested locally with JDK17 as well as CodeBuild job

@zoewangg zoewangg marked this pull request as ready for review September 7, 2022 22:07
@zoewangg zoewangg requested a review from a team as a code owner September 7, 2022 22:07
pom.xml Outdated
Comment on lines 221 to 237
<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>
Copy link
Contributor Author

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.

Copy link
Contributor Author

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

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.

@zoewangg zoewangg changed the title Fix javadoc to make it build with JDK17 Fix javadoc to make it build with JDK 17 Sep 9, 2022

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

100.0% 100.0% Coverage
0.0% 0.0% Duplication

@zoewangg zoewangg merged commit 1cbbbab into master Sep 13, 2022
@zoewangg zoewangg deleted the zoewang/modernizeJavadoc branch September 13, 2022 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants