Skip to content
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

chore: fix javadoc job by updating to the new javadoc output path #3184

Merged
merged 1 commit into from
Sep 3, 2024

Conversation

mpeddada1
Copy link
Contributor

@mpeddada1 mpeddada1 commented Sep 3, 2024

The default javadoc output path was changed from target/site to target/reports in apache/maven-reporting-impl#26 and was introduced in maven-javadoc-plugin:3.10.0 in apache/maven-javadoc-plugin#204.

The maven-javadoc-plugin was updated from 3.8.0 to 3.10.0 in v5.6.0 (PR). This fix aims to address the current failure in the publish_javadoc job:


# Move into generated docs directory
pushd target/site/apidocs/
github/spring-cloud-gcp/.kokoro/publish_javadoc.sh: line 29: pushd: target/site/apidocs/: No such file or directory


[ID: 8846228] Command finished after 191 secs, exit value: 1

@mpeddada1 mpeddada1 requested a review from a team as a code owner September 3, 2024 19:42
Copy link

sonarcloud bot commented Sep 3, 2024

Copy link
Contributor

@zhumin8 zhumin8 left a comment

Choose a reason for hiding this comment

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

Noticed the change was in "default value of output directory". I wonder if we can explicitly set this path in maven-javadoc-plugin, so we don't suffer similar issue in the future.

@mpeddada1
Copy link
Contributor Author

Noticed the change was in "default value of output directory". I wonder if we can explicitly set this path in maven-javadoc-plugin, so we don't suffer similar issue in the future.

That's a great idea! There is an option to specify the <outputDirectory> in maven-javadoc-plugin. However, modifying this plugin to include the following snippet doesn't seem to address the error seen above (at least when I tested it locally):

<configuration>
	<outputDirectory>${project.build.directory}/site</outputDirectory>
</configuration>

Perhaps we can explore this long term solution as a follow-up?

@mpeddada1 mpeddada1 merged commit 96890b8 into main Sep 3, 2024
74 of 77 checks passed
@mpeddada1 mpeddada1 deleted the javadoc-3.10.0-fix branch September 3, 2024 21:49
@suztomo
Copy link
Contributor

suztomo commented Sep 5, 2024

The default javadoc output path was changed from target/site to target/reports in apache/maven-reporting-impl#26 and was introduced in maven-javadoc-plugin:3.10.0 in apache/maven-javadoc-plugin#204.

That's great of you finding the source of the behavior change in upstream projects.

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.

4 participants