Serge Rielau created SPARK-56827:
------------------------------------
Summary: Fix doc CI build
Key: SPARK-56827
URL: https://issues.apache.org/jira/browse/SPARK-56827
Project: Spark
Issue Type: Bug
Components: Documentation
Affects Versions: 4.2.0
Reporter: Serge Rielau
Description
Spark’s documentation build path that runs JavaUnidoc (aggregated Javadoc for
the published API docs) is failing or unstable on recent {{master}} commits.
Failures show up as {{JavadocGenerationFailure}} (or equivalent) in the
Documentation / doc-generation CI job, not as test failures in application code.
This is build and doc-tooling infrastructure, not product SQL or runtime
behavior. Individual feature PRs should not need to carry unrelated fixes in
{{SparkBuild}} or doc plugins unless they directly touch the same surfaces.
Symptoms
* Doc / Unidoc job fails during Javadoc generation.
* May block merges when documentation checks are required, or force unrelated
PRs to be reverted if CI is interpreted as merge-blocking.
Impact
* Slows contribution and creates noise (reverts, “fix CI” commits unrelated to
the original change).
* Risk that real doc regressions are conflated with toolchain / dependency /
JDK issues.
Context (optional bullets for the ticket)
* Observed in the context of recent CI around documentation generation (link
the failing workflow run or commit SHA when you file).
* Related discussion may exist in other infra tickets or PRs (add links: e.g.
SPARK-56630 / #55581, SPARK-56666 / #55605 if those match what you saw—replace
with actual URLs).
Proposed scope
# Reproduce locally with the same command CI uses for documentation / Unidoc
(paste exact {{build/sbt}} or Maven goal from the failing log).
# Identify root cause: JDK version, {{javadoc}} options, missing/incorrect
module path, broken link in Javadoc, OOM, plugin version, etc.
# Fix in build scripts, doc config, or source Javadoc only where required;
avoid coupling unrelated feature PRs to this work.
Acceptance criteria
* Documentation (including JavaUnidoc) job completes successfully on
{{master}} in CI.
* Brief note in PR or commit message describing the root cause and fix (for
future regressions).
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
