This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch v2-10-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/v2-10-test by this push:
new 06684025c3 Doc update - Airflow local settings no longer importable
from dags folder (#42231) (#42603)
06684025c3 is described below
commit 06684025c3060ea40b5b232b2e9a8995d097f055
Author: Jarek Potiuk <[email protected]>
AuthorDate: Tue Oct 1 01:01:57 2024 -0700
Doc update - Airflow local settings no longer importable from dags folder
(#42231) (#42603)
---------
Co-authored-by: Jishan Garg <[email protected]>
(cherry picked from commit f4f38f15fe4e6c32614686ceb3b5991dd91ef7ee)
Co-authored-by: JISHAN GARGACHARYA
<[email protected]>
---
docs/apache-airflow/howto/set-config.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/docs/apache-airflow/howto/set-config.rst
b/docs/apache-airflow/howto/set-config.rst
index 4f19159a81..2a03b2bbf5 100644
--- a/docs/apache-airflow/howto/set-config.rst
+++ b/docs/apache-airflow/howto/set-config.rst
@@ -179,6 +179,8 @@ where you can configure such local settings - This is
usually done in the ``airf
You should create a ``airflow_local_settings.py`` file and put it in a
directory in ``sys.path`` or
in the ``$AIRFLOW_HOME/config`` folder. (Airflow adds ``$AIRFLOW_HOME/config``
to ``sys.path`` when
Airflow is initialized)
+Starting from Airflow 2.10.1, the $AIRFLOW_HOME/dags folder is no longer
included in sys.path at initialization, so any local settings in that folder
will not be imported. Ensure that airflow_local_settings.py is located in a
path that is part of sys.path during initialization, like $AIRFLOW_HOME/config.
+For more context about this change, see the `mailing list announcement
<https://lists.apache.org/thread/b4fcw33vh60yfg9990n5vmc7sy2dcgjx>`_.
You can see the example of such local settings here:
