chore: fix generate-release-docs.sh for per-Spark-version doc layout#4662
Merged
Merged
Conversation
andygrove
approved these changes
Jun 16, 2026
andygrove
left a comment
Member
There was a problem hiding this comment.
Thanks for fixing this @mbutrovich!
marvelshan
pushed a commit
to marvelshan/datafusion-comet
that referenced
this pull request
Jul 2, 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
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?
Closes #.
Rationale for this change
dev/generate-release-docs.shfreezes generated docs onto a release branch. It has been broken since #4139, which splitcompatibility/expressions/into per-Spark-version subdirectories (spark-3.4..spark-4.1) plus_category_template/. That PR updated the publish-time generator (docs/build.sh) andGenerateDocsbut not this script, so it still calledGenerateDocswith only the user-guide root, hit the removed flat path, and failed withFileNotFoundException: .../compatibility/expressions/cast.md. No release has been cut since, so it went unnoticed.What changes are included in this PR?
Bring the script in line with
docs/build.sh: loop the Spark profiles, copy_category_template/*.mdinto eachspark-<ver>/, and runGenerateDocsper profile with-Dexec.arguments="<latest-user-guide>,<profile>"to pass the subdirectory arg. Also runprettier --writeover the output, since CI checksprettier --check "**/*.md"and this script (unlikebuild.sh, whose temp output is throwaway) commits its result._category_template/is kept as committed source. The only difference frombuild.shis that this runs against the source tree so the freeze can be committed. The same fix lands onbranch-0.17bundled with the generated docs freeze; onmainthe generated docs are not committed, so this PR carries the script change alone.How are these changes tested?
Ran on a 0.17.0 release branch:
configs.mdpopulated, all fourspark-<ver>/dirs containcast.mdplus category pages with filled tables, per-version differences land where expected (map.md/misc.mddiffer 3.4 vs 4.1,misc.mddiffers 3.4 vs 3.5, 4.0 == 4.1), andprettier --checkpasses.