From a039e0827ae13be7119bebc74dc245f216a095bd Mon Sep 17 00:00:00 2001 From: Amol Patil Date: Tue, 17 Mar 2026 13:15:29 -0700 Subject: [PATCH 1/2] fix: move generated docs check out of rust workflow --- .github/workflows/rust.yml | 30 ------------------------------ 1 file changed, 30 deletions(-) diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index f7452ee603b1..6485cead45b3 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -694,36 +694,6 @@ jobs: - name: Check Cargo.toml formatting run: taplo format --check - config-docs-check: - name: check configs.md and ***_functions.md is up-to-date - needs: linux-build-lib - runs-on: ${{ github.repository_owner == 'apache' && format('runs-on={0},family=m8a+m7a+c8a,cpu=16,image=ubuntu24-full-x64,extras=s3-cache,disk=large,tag=datafusion', github.run_id) || 'ubuntu-latest' }} - container: - image: amd64/rust - steps: - - uses: runs-on/action@cd2b598b0515d39d78c38a02d529db87d2196d1e # v2.0.3 - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - with: - submodules: true - fetch-depth: 1 - - name: Setup Rust toolchain - uses: ./.github/actions/setup-builder - with: - rust-version: stable - - uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0 - with: - node-version: "20" - - name: Check if configs.md has been modified - run: | - # If you encounter an error, run './dev/update_config_docs.sh' and commit - ./dev/update_config_docs.sh - git diff --exit-code - - name: Check if any of the ***_functions.md has been modified - run: | - # If you encounter an error, run './dev/update_function_docs.sh' and commit - ./dev/update_function_docs.sh - git diff --exit-code - # This job ensures `datafusion-examples/README.md` stays in sync with the source code: # 1. Generates README automatically using the Rust examples docs generator # (parsing documentation from `examples//main.rs`) From af6028c3f8911981d13a61ac49fcfb8314765039 Mon Sep 17 00:00:00 2001 From: Amol Patil Date: Tue, 17 Mar 2026 13:15:30 -0700 Subject: [PATCH 2/2] fix: add dedicated generated docs workflow --- .github/workflows/docs_generated.yaml | 81 +++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 .github/workflows/docs_generated.yaml diff --git a/.github/workflows/docs_generated.yaml b/.github/workflows/docs_generated.yaml new file mode 100644 index 000000000000..0f9cf4f43a1d --- /dev/null +++ b/.github/workflows/docs_generated.yaml @@ -0,0 +1,81 @@ +# 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. + +name: Generated Docs + +concurrency: + group: ${{ github.repository }}-${{ github.head_ref || github.sha }}-${{ github.workflow }} + cancel-in-progress: true + +on: + push: + paths: + - ".github/workflows/docs_generated.yaml" + - ".github/actions/setup-builder/**" + - ".github/actions/setup-rust-runtime/**" + - "ci/scripts/utils/tool_versions.sh" + - "datafusion/**" + - "dev/update_config_docs.sh" + - "dev/update_function_docs.sh" + - "docs/source/user-guide/configs.md" + - "docs/source/user-guide/sql/aggregate_functions.md" + - "docs/source/user-guide/sql/scalar_functions.md" + - "docs/source/user-guide/sql/window_functions.md" + pull_request: + paths: + - ".github/workflows/docs_generated.yaml" + - ".github/actions/setup-builder/**" + - ".github/actions/setup-rust-runtime/**" + - "ci/scripts/utils/tool_versions.sh" + - "datafusion/**" + - "dev/update_config_docs.sh" + - "dev/update_function_docs.sh" + - "docs/source/user-guide/configs.md" + - "docs/source/user-guide/sql/aggregate_functions.md" + - "docs/source/user-guide/sql/scalar_functions.md" + - "docs/source/user-guide/sql/window_functions.md" + workflow_dispatch: + +jobs: + generated-docs-check: + name: check configs.md and ***_functions.md is up-to-date + runs-on: ${{ github.repository_owner == 'apache' && format('runs-on={0},family=m8a+m7a+c8a,cpu=16,image=ubuntu24-full-x64,extras=s3-cache,disk=large,tag=datafusion', github.run_id) || 'ubuntu-latest' }} + container: + image: amd64/rust + steps: + - uses: runs-on/action@cd2b598b0515d39d78c38a02d529db87d2196d1e # v2.0.3 + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + submodules: true + fetch-depth: 1 + - name: Setup Rust toolchain + uses: ./.github/actions/setup-builder + with: + rust-version: stable + - uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0 + with: + node-version: "20" + - name: Check if configs.md has been modified + run: | + # If you encounter an error, run './dev/update_config_docs.sh' and commit + ./dev/update_config_docs.sh + git diff --exit-code + - name: Check if any of the ***_functions.md has been modified + run: | + # If you encounter an error, run './dev/update_function_docs.sh' and commit + ./dev/update_function_docs.sh + git diff --exit-code