You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "sunank200 (via GitHub)" <gi...@apache.org> on 2025/06/18 08:58:44 UTC
[PR] Reorganize docs tests for task-sdk into task-sdk/tests/docs [airflow]
sunank200 opened a new pull request, #51876:
URL: https://github.com/apache/airflow/pull/51876
<!--
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.
-->
This is follow up PR based on this comment https://github.com/apache/airflow/pull/51153#discussion_r2139672481
This PR refactors our tests for task-sdk by moving all docs-related tests into a dedicated docs directory.
closes: [#51519](https://github.com/apache/airflow/issues/51519)
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Reorganize docs tests for task-sdk into task-sdk/tests/docs [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #51876:
URL: https://github.com/apache/airflow/pull/51876#issuecomment-2983401900
Ah yeah - I see they run "sphinx-build"...
BTW. Why not making it as sphinx extension instead? We have also a number of sphinx extensions that are run during the build of documentation and it means that they are running as part of "doc build" phase automatically.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Reorganize docs tests for task-sdk into task-sdk/tests/docs [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk merged PR #51876:
URL: https://github.com/apache/airflow/pull/51876
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Reorganize docs tests for task-sdk into task-sdk/tests/docs [airflow]
Posted by "sunank200 (via GitHub)" <gi...@apache.org>.
sunank200 commented on PR #51876:
URL: https://github.com/apache/airflow/pull/51876#issuecomment-2994999189
> Ah yeah - I see they run "sphinx-build"...
>
> BTW. Why not making it as sphinx extension instead? We have also a number of sphinx extensions that are run during the build of documentation and it means that they are running as part of "doc build" phase automatically.
@potiuk I can take as part of next PR.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Reorganize docs tests for task-sdk into task-sdk/tests/docs [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #51876:
URL: https://github.com/apache/airflow/pull/51876#issuecomment-2995096634
> @potiuk I can take as part of next PR.
Yep. Not needed now :). Just something to consider.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Reorganize docs tests for task-sdk into task-sdk/tests/docs [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #51876:
URL: https://github.com/apache/airflow/pull/51876#issuecomment-2983409749
See https://github.com/apache/airflow/tree/main/devel-common/src/sphinx_exts
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Reorganize docs tests for task-sdk into task-sdk/tests/docs [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #51876:
URL: https://github.com/apache/airflow/pull/51876#issuecomment-2983327768
I would even propose to turn them into scripts and run them via pre-commit. Those tests are fast and can be easily run every time "task-sdk" changes and they are much more like "static" tests than "unit tests"
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Reorganize docs tests for task-sdk into task-sdk/tests/docs [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on PR #51876:
URL: https://github.com/apache/airflow/pull/51876#issuecomment-2983330356
You don't even have to add it to "scripts/ci/pre-commit" -> you can easily run them directly from here.
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Reorganize docs tests for task-sdk into task-sdk/tests/docs [airflow]
Posted by "sunank200 (via GitHub)" <gi...@apache.org>.
sunank200 commented on PR #51876:
URL: https://github.com/apache/airflow/pull/51876#issuecomment-2983353330
> I would even propose to turn them into scripts and run them via pre-commit. Those tests are fast and can be easily run every time "task-sdk" changes and they are much more like "static" tests than "unit tests"
@potiuk These public‐api checks are true pytest tests - they import the package at runtime, inspect __all__, and assert what’s actually there. I think pre-commit hooks in Airflow are intended to be fast, static linters or formatters, and they shouldn’t be reaching into the code to execute 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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org