Skip to content

Commit bf4d7fe

Browse files
authored
Merge branch 'main' into bugfix/improve-dag-callback-context
2 parents 1b6068f + 2525023 commit bf4d7fe

File tree

6 files changed

+69
-4
lines changed

6 files changed

+69
-4
lines changed

.devcontainer/devcontainer.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
"../scripts/ci/docker-compose/devcontainer.yml",
55
"../scripts/ci/docker-compose/devcontainer-sqlite.yml"
66
],
7+
"features": {
8+
"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {}
9+
},
710
"settings": {
811
"terminal.integrated.defaultProfile.linux": "bash"
912
},

.devcontainer/mysql/devcontainer.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
"../../scripts/ci/docker-compose/backend-mysql.yml",
66
"../../scripts/ci/docker-compose/devcontainer-mysql.yml"
77
],
8+
"features": {
9+
"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {}
10+
},
811
"settings": {
912
"terminal.integrated.defaultProfile.linux": "bash"
1013
},

.devcontainer/postgres/devcontainer.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
"../../scripts/ci/docker-compose/backend-postgres.yml",
66
"../../scripts/ci/docker-compose/devcontainer-postgres.yml"
77
],
8+
"features": {
9+
"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {}
10+
},
811
"settings": {
912
"terminal.integrated.defaultProfile.linux": "bash"
1013
},

contributing-docs/03a_contributors_quick_start_beginners.rst

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,17 @@ Option B – One-Click GitHub Codespaces
148148
chmod +x ~/.docker/cli-plugins/docker-compose
149149
docker compose version
150150
151-
4. Install Breeze and start the development container
151+
4. Verify Docker is accessible
152+
153+
.. code-block:: bash
154+
155+
docker info
156+
157+
If ``docker info`` fails, try rebuilding the Codespace container
158+
(Command Palette → *Codespaces: Rebuild Container*) or restarting
159+
the Codespace from the GitHub Codespaces dashboard.
160+
161+
5. Install Breeze and start the development container
152162

153163
.. code-block:: bash
154164
@@ -160,10 +170,10 @@ Option B – One-Click GitHub Codespaces
160170
uv run dev/ide_setup/setup_vscode.py
161171
breeze start-airflow
162172
163-
5. Edit a file in the editor, save, and commit via the Source Control sidebar.
173+
6. Edit a file in the editor, save, and commit via the Source Control sidebar.
164174
Push when prompted.
165175

166-
6. Press **Create pull request** when GitHub offers.
176+
7. Press **Create pull request** when GitHub offers.
167177

168178

169179

contributing-docs/quick-start-ide/contributors_quick_start_codespaces.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,38 @@ Setup and develop using GitHub Codespaces
4646
as Codespaces use Visual Studio Code as interface.
4747

4848

49+
Troubleshooting Docker in Codespaces
50+
-------------------------------------
51+
52+
If you see a "Docker is not running" error when running Breeze commands, try these steps:
53+
54+
1. Verify that Docker is accessible by running:
55+
56+
.. code-block:: bash
57+
58+
docker info
59+
60+
2. If the command fails, check that the Docker socket exists:
61+
62+
.. code-block:: bash
63+
64+
ls -la /var/run/docker.sock
65+
66+
3. Check that your user has permission to access Docker:
67+
68+
.. code-block:: bash
69+
70+
groups $USER
71+
72+
You should see ``docker`` in the list. If not, add yourself to the group:
73+
74+
.. code-block:: bash
75+
76+
sudo usermod -aG docker $USER
77+
78+
4. If the above steps do not help, rebuild the devcontainer
79+
(Command Palette → *Codespaces: Rebuild Container*) or restart the Codespace
80+
from the GitHub Codespaces dashboard.
81+
82+
4983
Follow the `Quick start <../03b_contributors_quick_start_seasoned_developers.rst>`_ for typical development tasks.

dev/breeze/src/airflow_breeze/utils/docker_command_utils.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,14 +175,26 @@ def check_docker_is_running():
175175
response = run_command(
176176
["docker", "info"],
177177
no_output_dump_on_exception=True,
178-
text=False,
178+
text=True,
179179
capture_output=True,
180180
check=False,
181181
)
182182
if response.returncode != 0:
183183
get_console().print(
184184
"[error]Docker is not running.[/]\n[warning]Please make sure Docker is installed and running.[/]"
185185
)
186+
if response.stderr:
187+
get_console().print(f"\n[warning]Docker error output:[/]\n{response.stderr.strip()}")
188+
if os.environ.get("CODESPACES", "").lower() == "true":
189+
get_console().print(
190+
"\n[info]It looks like you are running in a GitHub Codespace.[/]\n"
191+
"[info]Try the following troubleshooting steps:[/]\n"
192+
" 1. Check if the Docker socket exists: ls -la /var/run/docker.sock\n"
193+
" 2. Check Docker socket permissions: groups $USER\n"
194+
" 3. Try restarting the Codespace from the GitHub Codespaces dashboard\n"
195+
" 4. If the issue persists, rebuild the devcontainer "
196+
"(Command Palette -> 'Codespaces: Rebuild Container')\n"
197+
)
186198
sys.exit(1)
187199

188200

0 commit comments

Comments
 (0)