findepi commented on code in PR #17046: URL: https://github.com/apache/datafusion/pull/17046#discussion_r2259750941
########## .github/workflows/docs_generated.yaml: ########## @@ -0,0 +1,77 @@ + +# 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/**" + - "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/**" + - "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" Review Comment: Easy to miss adding a new document here. Can we run this workflow on any changes to the user guide? ########## .github/workflows/docs_generated.yaml: ########## @@ -0,0 +1,77 @@ + +# 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/**" + - "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/**" + - "datafusion/**" Review Comment: Cargo.toml, cargo.lock, rust-toolchain.toml, ? ########## .github/workflows/docs_generated.yaml: ########## @@ -0,0 +1,77 @@ + +# 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/**" + - "datafusion/**" Review Comment: This will have the downside of running on forks on dev branches as well. Worth limiting to just `main`? (i am aware the dev workflow doesn't limit itself) Also, can we afford running it on main unconditionally, without path filter? This way we won't get blind when `./dev/update_config_docs.sh` is changed and updates some new doc location, or depends on some new file (like `rust-toolchain.toml`) ########## .github/workflows/docs_generated.yaml: ########## @@ -0,0 +1,77 @@ + +# 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/**" + - "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/**" + - "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" + # manual trigger + # https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow + workflow_dispatch: + +jobs: + generated-docs-check: + name: check configs.md and ***_functions.md is up-to-date + runs-on: ubuntu-latest + container: + image: amd64/rust + steps: + - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 Review Comment: I think `actions/checkout` is controlled by GitHub. I believe it's safe to use tag reference on this one and the setup-node as well. ########## .github/workflows/docs_generated.yaml: ########## @@ -0,0 +1,77 @@ + Review Comment: ```suggestion ``` -- 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: github-unsubscr...@datafusion.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: github-unsubscr...@datafusion.apache.org For additional commands, e-mail: github-h...@datafusion.apache.org
