Skip to content

Commit 018ff3a

Browse files
authored
update breeze Option B quick setup (apache#56333)
1 parent 72259fe commit 018ff3a

File tree

1 file changed

+34
-12
lines changed

1 file changed

+34
-12
lines changed

contributing-docs/03a_contributors_quick_start_beginners.rst

Lines changed: 34 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -123,24 +123,46 @@ This flag enables configuration to load example DAGs when starting Airflow, whic
123123
124124
git fetch upstream && git rebase upstream/main && git push --force-with-lease
125125
126-
Option B – One-Click GitHub Codespaces
127-
-------------------------------------
126+
## Option B – One-Click GitHub Codespaces
127+
128128
1. On **your fork**, click *Code → Codespaces → New codespace*.
129129
2. Wait for the VS Code web IDE to appear. A terminal opens automatically.
130-
3. Install Breeze and start the development container
130+
3. Install Docker Buildx and Docker Compose (required for Breeze)
131131

132132
.. code-block:: bash
133133
134-
curl -LsSf https://astral.sh/uv/install.sh | sh
135-
uv tool install prek
136-
prek install -f
137-
uv tool install -e ./dev/breeze
138-
uv run setup_vscode.py
139-
breeze start-airflow
134+
```
135+
mkdir -p ~/.docker/cli-plugins
136+
137+
# Install Docker Buildx
138+
BUILDX_VERSION=v0.16.2
139+
curl -SL "https://github.com/docker/buildx/releases/download/${BUILDX_VERSION}/buildx-${BUILDX_VERSION}.linux-amd64" -o ~/.docker/cli-plugins/docker-buildx
140+
chmod +x ~/.docker/cli-plugins/docker-buildx
141+
docker buildx version
142+
143+
# Install Docker Compose v2
144+
curl -SL "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s | tr '[:upper:]' '[:lower:]')-$(uname -m)" -o ~/.docker/cli-plugins/docker-compose
145+
chmod +x ~/.docker/cli-plugins/docker-compose
146+
docker compose version
147+
```
148+
149+
4. Install Breeze and start the development container
150+
151+
.. code-block:: bash
152+
153+
```
154+
curl -LsSf https://astral.sh/uv/install.sh | sh
155+
uv tool install prek
156+
prek install -f
157+
uv tool install -e ./dev/breeze
158+
uv run setup_vscode.py
159+
breeze start-airflow
160+
```
161+
162+
5. Edit a file in the editor, save, and commit via the Source Control
163+
sidebar. Push when prompted.
164+
6. Press **Create pull request** when GitHub offers.
140165

141-
4. Edit a file in the editor, save, and commit via the Source Control
142-
sidebar. Push when prompted.
143-
5. Press **Create pull request** when GitHub offers.
144166

145167
Review & Merge
146168
--------------

0 commit comments

Comments
 (0)