cj-zhukov commented on PR #19750: URL: https://github.com/apache/datafusion/pull/19750#issuecomment-3734532489
### High-Level Overview In previous PRs, a basic script was introduced that only parsed example group names https://github.com/apache/datafusion/pull/19371 and https://github.com/apache/datafusion/pull/19491 This PR implements a more comprehensive solution for keeping the examples README up-to-date: 1. Introduces a new examples.toml file, which contains metadata for examples, including: - subcommand — the command used with cargo run --example [group] -- [subcommand] - file — the actual Rust source file - desc — a short description of the example 2. Updates the generate_examples_docs.sh script to: - Parse examples.toml - Check that all examples in the filesystem exist and are listed in the TOML - Generate a new README file as README-NEW.md 3. Integrates CI validation: - README-NEW.md is formatted with DataFusion’s Prettier - Compared against the committed README.md - If there are differences, the CI check fails and prints a clear diff, along with instructions for updating the README after verifying examples.toml This ensures that the README for examples stays in sync with the actual examples and encourages maintainers to keep examples.toml accurate. -- 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]
