This is an automated email from the ASF dual-hosted git repository.
kaxilnaik pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new ea61ff7b6f8 docs(ruff): fix outdated content and add airflow rule
list, ruff configuration links (#50232)
ea61ff7b6f8 is described below
commit ea61ff7b6f8e7353704ca2f7aafd316ac5515336
Author: Wei Lee <[email protected]>
AuthorDate: Tue May 6 20:39:26 2025 +0800
docs(ruff): fix outdated content and add airflow rule list, ruff
configuration links (#50232)
---
airflow-core/docs/best-practices.rst | 10 +++-------
airflow-core/docs/installation/upgrading_to_airflow3.rst | 3 +++
2 files changed, 6 insertions(+), 7 deletions(-)
diff --git a/airflow-core/docs/best-practices.rst
b/airflow-core/docs/best-practices.rst
index bc4889b5f20..268f3e7150f 100644
--- a/airflow-core/docs/best-practices.rst
+++ b/airflow-core/docs/best-practices.rst
@@ -303,11 +303,7 @@ Code Quality and Linting
Maintaining high code quality is essential for the reliability and
maintainability of your Airflow workflows. Utilizing linting tools can help
identify potential issues and enforce coding standards. One such tool is
``ruff``, a fast Python linter that now includes specific rules for Airflow.
-ruff assists in detecting deprecated features and patterns that may affect
your migration to Airflow 3.0. For instance, it includes rules prefixed with
``AIR`` to flag potential issues:
-
-- **AIR301**: Flags DAGs without an explicit ``schedule`` argument.
-- **AIR302**: Identifies usage of deprecated ``schedule_interval`` parameter.
-- **AIR303**: Detects imports from modules that have been relocated or removed
in Airflow 3.0.
+ruff assists in detecting deprecated features and patterns that may affect
your migration to Airflow 3.0. For instance, it includes rules prefixed with
``AIR`` to flag potential issues. The full list is detailed in `Airflow (AIR)
<https://docs.astral.sh/ruff/rules/#airflow-air>`_.
Installing and Using ruff
-------------------------
@@ -316,13 +312,13 @@ Installing and Using ruff
.. code-block:: bash
- pip install "ruff>=0.9.5"
+ pip install "ruff>=0.11.6"
2. **Running ruff**: Execute ``ruff`` to check your dags for potential issues:
.. code-block:: bash
- ruff check dags/ --select AIR301,AIR302,AIR303
+ ruff check dags/ --select AIR3 --preview
This command will analyze your dags located in the ``dags/`` directory and
report any issues related to the specified rules.
diff --git a/airflow-core/docs/installation/upgrading_to_airflow3.rst
b/airflow-core/docs/installation/upgrading_to_airflow3.rst
index 88057087967..9921f89416e 100644
--- a/airflow-core/docs/installation/upgrading_to_airflow3.rst
+++ b/airflow-core/docs/installation/upgrading_to_airflow3.rst
@@ -70,6 +70,9 @@ Some changes can be automatically fixed. To do so, run the
following command:
ruff check dag/ --select AIR301 --fix --preview
+
+You can also configure these flags through configuration files. See
`Configuring Ruff <Configuring Ruff>`_ for details.
+
Step 4: Install the Standard Providers
--------------------------------------
