adp2201 commented on issue #19095:
URL: https://github.com/apache/datafusion/issues/19095#issuecomment-4064309069
I reproduced this locally.
The failure mode is that a docs-only change to an autogenerated Markdown
file under `docs/` skips the workflow that contains the generated-doc
consistency checks.
What I verified:
- The generated-doc checks live in `.github/workflows/rust.yml`:
- `Check if configs.md has been modified`
- `Check if any of the ***_functions.md has been modified`
- That same workflow is gated by `paths-ignore` for:
- `docs/**`
- `**.md`
So if a PR changes only generated Markdown such as:
- `docs/source/user-guide/configs.md`
- `docs/source/user-guide/sql/*_functions.md`
then `rust.yml` is skipped, which means the generated-doc drift checks never
run.
I also checked the docs PR workflow:
- `.github/workflows/docs_pr.yaml` runs for `docs/**`
- it builds the docs, but it does not run `./dev/update_config_docs.sh` or
`./dev/update_function_docs.sh`
So the issue is real: generated docs can be edited directly, the docs
workflow still passes, and the sync check is bypassed until a later non-doc PR
hits the Rust workflow.
I used a temporary one-line edit to
`docs/source/user-guide/sql/scalar_functions.md` to validate the trigger
behavior, then reverted it.
--
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]
