mirror of
https://github.com/langchain-ai/datafusion.git
synced 2026-07-18 13:15:59 -04:00
Sergey Zhukov
80485d7516
## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123. --> - Closes #https://github.com/apache/datafusion/issues/20024. ## Rationale for this change <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. --> ## Are these changes tested? <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 2. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. -->
78 lines
2.6 KiB
Bash
Executable File
78 lines
2.6 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
#
|
|
# Licensed to the Apache Software Foundation (ASF) under one
|
|
# or more contributor license agreements. See the NOTICE file
|
|
# distributed with this work for additional information
|
|
# regarding copyright ownership. The ASF licenses this file
|
|
# to you under the Apache License, Version 2.0 (the
|
|
# "License"); you may not use this file except in compliance
|
|
# with the License. You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing,
|
|
# software distributed under the License is distributed on an
|
|
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
# KIND, either express or implied. See the License for the
|
|
# specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
# Generates documentation for DataFusion examples using the Rust-based
|
|
# documentation generator and verifies that the committed README.md
|
|
# is up to date.
|
|
#
|
|
# The README is generated from documentation comments in:
|
|
# datafusion-examples/examples/<group>/main.rs
|
|
#
|
|
# This script is intended to be run in CI to ensure that example
|
|
# documentation stays in sync with the code.
|
|
#
|
|
# To update the README locally, run this script and replace README.md
|
|
# with the generated output.
|
|
|
|
set -euo pipefail
|
|
|
|
ROOT_DIR="$(git rev-parse --show-toplevel)"
|
|
|
|
# Load centralized tool versions
|
|
source "${ROOT_DIR}/ci/scripts/utils/tool_versions.sh"
|
|
|
|
EXAMPLES_DIR="$ROOT_DIR/datafusion-examples"
|
|
README="$EXAMPLES_DIR/README.md"
|
|
README_NEW="$EXAMPLES_DIR/README-NEW.md"
|
|
|
|
echo "▶ Generating examples README (Rust generator)…"
|
|
cargo run --quiet \
|
|
--manifest-path "$EXAMPLES_DIR/Cargo.toml" \
|
|
--bin examples-docs \
|
|
> "$README_NEW"
|
|
|
|
echo "▶ Formatting generated README with prettier ${PRETTIER_VERSION}…"
|
|
npx "prettier@${PRETTIER_VERSION}" \
|
|
--parser markdown \
|
|
--write "$README_NEW"
|
|
|
|
echo "▶ Comparing generated README with committed version…"
|
|
|
|
if ! diff -u "$README" "$README_NEW" > /tmp/examples-readme.diff; then
|
|
echo ""
|
|
echo "❌ Examples README is out of date."
|
|
echo ""
|
|
echo "The examples documentation is generated automatically from:"
|
|
echo " - datafusion-examples/examples/<group>/main.rs"
|
|
echo ""
|
|
echo "To update the README locally, run:"
|
|
echo ""
|
|
echo " cargo run --bin examples-docs \\"
|
|
echo " | npx prettier@${PRETTIER_VERSION} --parser markdown --write \\"
|
|
echo " > datafusion-examples/README.md"
|
|
echo ""
|
|
echo "Diff:"
|
|
echo "------------------------------------------------------------"
|
|
cat /tmp/examples-readme.diff
|
|
echo "------------------------------------------------------------"
|
|
exit 1
|
|
fi
|
|
|
|
echo "✅ Examples README is up-to-date."
|