andygrove opened a new pull request, #3212: URL: https://github.com/apache/datafusion-comet/pull/3212
Closes https://github.com/apache/datafusion-comet/issues/2582 ## Summary Move documentation generation from build time to publish time to prevent merge conflicts in PRs. Previously, GenerateDocs ran during mvn package and modified docs/source/user-guide/latest/configs.md and compatibility.md in-place. When PRs added new configs or expressions, the regenerated tables would conflict with main. Now: - Source docs contain only template markers (no generated content) - Content is generated at publish time in docs/build.sh - Release branches freeze generated content via dev/generate-release-docs.sh Changes - spark/pom.xml: Remove exec-maven-plugin that ran GenerateDocs during package phase - docs/build.sh: Add step to compile and run GenerateDocs against temp copy before Sphinx build - docs/source/user-guide/latest/configs.md: Replace generated tables with empty template markers - docs/source/user-guide/latest/compatibility.md: Replace generated tables with empty template markers - dev/generate-release-docs.sh: New script to generate docs when creating a release branch - dev/release/README.md: Add "Generate Release Documentation" step to release process - CLAUDE.md: Document the new workflow How It Works ┌────────────┬──────────────────────────┬──────────────────────────────┐ │ Branch │ Source Docs State │ When Generated │ ├────────────┼──────────────────────────┼──────────────────────────────┤ │ main │ Empty template markers │ At publish time by CI │ ├────────────┼──────────────────────────┼──────────────────────────────┤ │ branch-0.x │ Frozen generated content │ Once, when branch is created │ └────────────┴──────────────────────────┴──────────────────────────────┘ Release Process Addition When cutting a new release: git checkout -b branch-0.13 main ./dev/generate-release-docs.sh git add docs/source/user-guide/latest/ git commit -m "Generate docs for 0.13.0 release" git push apache branch-0.13 Test Plan - Verify make no longer modifies docs - Verify docs/build.sh generates content correctly (test locally or check CI) - Verify dev/generate-release-docs.sh works on a test branch -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
