This is an automated email from the ASF dual-hosted git repository.
jasonliu 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 6e6aaa8a5c1 Move IDE setup scripts to `dev/ide_setup` (#61309)
6e6aaa8a5c1 is described below
commit 6e6aaa8a5c19f4c7b3fbaab82020a73d334fa43b
Author: Jed Cunningham <[email protected]>
AuthorDate: Sun Feb 1 06:20:13 2026 -0700
Move IDE setup scripts to `dev/ide_setup` (#61309)
Moves `setup_idea.py` and `setup_vscode.py` from the repo root to
`dev/ide_setup` to declutter the root directory. Updates the scripts
to correctly resolve the repository root from their new location,
and updates documentation references to point to the new paths.
---
contributing-docs/03a_contributors_quick_start_beginners.rst | 6 +++---
contributing-docs/20_debugging_airflow_components.rst | 2 +-
.../quick-start-ide/contributors_quick_start_pycharm.rst | 4 ++--
setup_idea.py => dev/ide_setup/setup_idea.py | 2 +-
setup_vscode.py => dev/ide_setup/setup_vscode.py | 2 +-
5 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/contributing-docs/03a_contributors_quick_start_beginners.rst
b/contributing-docs/03a_contributors_quick_start_beginners.rst
index 3bdac3aa4b9..0427a7c19c3 100644
--- a/contributing-docs/03a_contributors_quick_start_beginners.rst
+++ b/contributing-docs/03a_contributors_quick_start_beginners.rst
@@ -74,10 +74,10 @@ Option A – Breeze on Your Laptop
.. code-block:: text
# For IntelliJ IDEA and PyCharm
- uv run setup_idea.py
+ uv run dev/ide_setup/setup_idea.py
# For VS Code
- uv run setup_vscode.py
+ uv run dev/ide_setup/setup_vscode.py
3. **Start the development container** (first run builds the image)
@@ -157,7 +157,7 @@ Option B – One-Click GitHub Codespaces
prek install -f
prek install -f --hook-type pre-push # for running mypy checks when
pushing to repo
uv tool install -e ./dev/breeze
- uv run setup_vscode.py
+ uv run dev/ide_setup/setup_vscode.py
breeze start-airflow
5. Edit a file in the editor, save, and commit via the Source Control sidebar.
diff --git a/contributing-docs/20_debugging_airflow_components.rst
b/contributing-docs/20_debugging_airflow_components.rst
index ab265a4ca2e..d7798baab1e 100644
--- a/contributing-docs/20_debugging_airflow_components.rst
+++ b/contributing-docs/20_debugging_airflow_components.rst
@@ -106,7 +106,7 @@ Setting up VSCode for Remote Debugging
.. code-block:: bash
- python setup_vscode.py
+ uv run dev/ide_setup/setup_vscode.py
This will create debug configurations for all Airflow components. Here's an
example configuration for the scheduler:
diff --git
a/contributing-docs/quick-start-ide/contributors_quick_start_pycharm.rst
b/contributing-docs/quick-start-ide/contributors_quick_start_pycharm.rst
index 5ec2415ee4e..cdb691a7e5b 100644
--- a/contributing-docs/quick-start-ide/contributors_quick_start_pycharm.rst
+++ b/contributing-docs/quick-start-ide/contributors_quick_start_pycharm.rst
@@ -60,7 +60,7 @@ Or for specific provider and its cross-provider dependencies:
Next: Configure your IDEA project.
3. The fastest way to add source roots is to configure the ``airflow.iml``
file under ``.idea`` directory and update the
- ``module.xml`` file using the ``setup_idea.py`` script:
+ ``module.xml`` file using the ``dev/ide_setup/setup_idea.py`` script:
To setup the source roots for all the modules that exist in the project,
you can run the following command:
This needs to done on the Airflow repository root directory. It overwrites
the existing ``.idea/airflow.iml`` and
@@ -68,7 +68,7 @@ Next: Configure your IDEA project.
.. code-block:: bash
- $ uv run setup_idea.py
+ $ uv run dev/ide_setup/setup_idea.py
Then Restart the PyCharm/IntelliJ IDEA.
diff --git a/setup_idea.py b/dev/ide_setup/setup_idea.py
similarity index 99%
rename from setup_idea.py
rename to dev/ide_setup/setup_idea.py
index b94df61fe13..597be56ea53 100755
--- a/setup_idea.py
+++ b/dev/ide_setup/setup_idea.py
@@ -90,7 +90,7 @@ source_root_modules: list[str] = [
all_module_paths: list[str] = []
-ROOT_AIRFLOW_FOLDER_PATH = Path(__file__).parent
+ROOT_AIRFLOW_FOLDER_PATH = Path(__file__).parents[2]
IDEA_FOLDER_PATH = ROOT_AIRFLOW_FOLDER_PATH / ".idea"
AIRFLOW_IML_FILE = IDEA_FOLDER_PATH / "airflow.iml"
MODULES_XML_FILE = IDEA_FOLDER_PATH / "modules.xml"
diff --git a/setup_vscode.py b/dev/ide_setup/setup_vscode.py
similarity index 98%
rename from setup_vscode.py
rename to dev/ide_setup/setup_vscode.py
index 56b53f6fd93..e8f4c3d8d9a 100755
--- a/setup_vscode.py
+++ b/dev/ide_setup/setup_vscode.py
@@ -49,7 +49,7 @@ COMPONENT_NAMES = {
"edge-worker": "Edge Worker",
}
-ROOT_AIRFLOW_FOLDER_PATH = Path(__file__).parent
+ROOT_AIRFLOW_FOLDER_PATH = Path(__file__).parents[2]
VSCODE_FOLDER_PATH = ROOT_AIRFLOW_FOLDER_PATH / ".vscode"
LAUNCH_JSON_FILE = VSCODE_FOLDER_PATH / "launch.json"
