kumarUjjawal opened a new pull request, #25525: URL: https://github.com/apache/datafusion/pull/25525
## Which issue does this PR close? - Part of #21048. ## Rationale for this change `dev/rust_lint.sh` does not check the generated `configs.md` and function pages. A contributor finds a stale page only in the `config-docs-check` job. That job also regenerates the tracked pages in place and then runs `git diff`, so the same check cannot run in a working tree with other changes. ## What changes are included in this PR? - `ci/scripts/check_config_function_docs.sh` regenerates the four pages into per-run scratch directories, compares each with its working file, and prints a diff for each stale page. Check mode never rewrites a page. `--write` replaces the four pages, with the same clean-tree rule as `rust_fmt.sh`. - `dev/update_config_docs.sh` and `dev/update_function_docs.sh` gain `--output-dir DIR`, so the checker reuses the existing generators and headers. Without the option, both scripts behave as before. - `dev/rust_lint.sh` runs the checker as a write step. - The `config-docs-check` job runs the checker and keeps its `git diff --exit-code` guard. The job identity and setup do not change. - `docs/source/contributor-guide/testing.md` documents the check and the update command. ## What is the testing strategy for this PR? - In a clean clone with the real generators: the no-argument scripts and `--output-dir` produce byte-identical pages, the four committed pages pass, a committed stale page fails with its diff, `--write` restores it byte for byte, the dirty-tree gate refuses, and staged edits survive check mode. No lockfile changed. - A fixture with stub `cargo` and `npx` covered each page stale on its own, generator and formatter failures in both modes, cleanup after failure and interruption, concurrent runs, missing `npx`, comparison errors, and argument errors. No page changed in any failure case. - The parsed workflow matches `main` except the replaced steps. The full `./dev/rust_lint.sh` passes. ## Are there any user-facing changes? No. 🤖 Generated with [Claude Code](https://claude.com/claude-code) -- 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]
