ci: republish docs site when generated-doc sources change - #4777
Merged
Merged
Conversation
The docs deploy job only runs when compute-changes.py reports docs=true, which previously matched only .asf.yaml, the docs workflow, and docs/**. The published site also contains content generated by GenerateDocs (configs.md and the per-version expression compatibility pages), built from Scala sources. Changes to those sources did not republish the site unless a docs/ file happened to change in the same push, so generated pages could drift from main. Add the GenerateDocs input paths (CometConf, GenerateDocs, the serde and expressions packages, and the per-version shim directories) to the docs filter so the site republishes when generated content changes.
marvelshan
pushed a commit
to marvelshan/datafusion-comet
that referenced
this pull request
Jul 2, 2026
comphead
pushed a commit
to comphead/arrow-datafusion-comet
that referenced
this pull request
Aug 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Which issue does this PR close?
N/A
Rationale for this change
The docs deploy job (
docs.yaml, invoked fromci.yml) only runs whendev/ci/compute-changes.pyreportsdocs=true. That filter previously matched only.asf.yaml, the docs workflow itself, anddocs/**.However, the published site also contains content generated at build time by
GenerateDocs(theconfigs.mdtable and the per-version expression compatibility pages). That content is derived from Scala sources, not from files underdocs/. As a result, a push tomainthat changed an expression's support level, a config, or a serde, but did not touch anydocs/file, would not republish the site, so the generated pages could drift frommain.(This is not a regression from the recent CI refactor: the standalone docs workflow used the same path filter. The refactor to a reusable
workflow_callis only why those runs no longer appear under thedocs.yamlworkflow page; the deploy still runs as a job inside CI.)What changes are included in this PR?
Add the
GenerateDocsinput paths to thedocsfilter incompute-changes.py:spark/src/main/scala/org/apache/comet/CometConf.scala(feedsconfigs.md)spark/src/main/scala/org/apache/comet/GenerateDocs.scala(the generator)spark/src/main/scala/org/apache/comet/serde/**(expression serde maps and compatibility notes)spark/src/main/scala/org/apache/comet/expressions/**(e.g.CometCastcast compatibility)spark/src/main/spark-*/**(per-version shims that register some expressions)Native, test-only, and CI-only changes still do not republish the site, since none of them affect the generated content.
How are these changes tested?
Validated the new globs against the script's own matcher: each added source path classifies as
docs=true, while native (native/**), test (spark/src/test/**), common Java, and unrelatedspark/src/mainpaths (e.g.org/apache/spark/sql/comet/CometScanExec.scala) still classify asdocs=false.