Fix/javadoc package list error #2514
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Did you read the Contributor Guide?
Yes, I have read the Contributor Rules and Contributor Development Guide
No, I haven't read it.
Is this PR related to a ticket?
Yes, and the PR name follows the format [GH-1893] Fix JavaDoc package-list error in docs build workflow. Closes #1893
No:
this is a documentation update. The PR name follows the format [DOCS] my subject
this is a CI update. The PR name follows the format [CI] my subject
What changes were proposed in this PR?
This PR fixes the JavaDoc build error reported in issue #1893, where the build failed with Error fetching link: .../common/target/target/apidocs/package-list.
The issue was caused by the spark/common module trying to link to the common module's JavaDoc, but the common module's JavaDoc was not being copied to the documentation directory in the GitHub Actions workflow.
This patch updates the .github/workflows/docs.yml file to explicitly copy the common module's generated JavaDoc to docs/api/javadoc/common/. This ensures the package-list file exists at the expected location for linking.
How was this patch tested?
Verified the workflow syntax and path logic.
Ran mvn -q clean install -DskipTests locally to ensure the build process works.
The CI build for this PR will serve as the final verification.
Did this PR include necessary documentation updates?
Yes, I am adding a new API. I am using the current SNAPSHOT version number in vX.Y.Z format.
Yes, I have updated the documentation.
No, this PR does not affect any public API so no need to change the documentation.