Skip to content

Commit 3dfc4d4

Browse files
jason810496claude
andcommitted
Break the new dag_bundle_name docs only at sentence ends
Co-Authored-By: Claude <noreply@anthropic.com>
1 parent f4fcbf2 commit 3dfc4d4

7 files changed

Lines changed: 28 additions & 18 deletions

File tree

‎airflow-core/docs/authoring-and-scheduling/language-sdks/go.rst‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,10 @@ then register the coordinator and route the queue to it in ``airflow.cfg`` (or t
207207
}
208208
queue_to_coordinator = {"golang": "go"}
209209
210-
``dag_bundle_name`` names the Dag bundle the coordinator scans for executable bundles. Omit it to ship the executable bundles in the same Dag bundle as the Python stub Dag. ``queue_to_coordinator`` routes stub tasks with ``queue="golang"`` to this Go coordinator. See :ref:`go-sdk/coordinator-config` for the full list of accepted ``kwargs``.
210+
``dag_bundle_name`` names the Dag bundle the coordinator scans for executable bundles.
211+
Omit it to ship the executable bundles in the same Dag bundle as the Python stub Dag.
212+
``queue_to_coordinator`` routes stub tasks with ``queue="golang"`` to this Go coordinator.
213+
See :ref:`go-sdk/coordinator-config` for the full list of accepted ``kwargs``.
211214

212215
There is no separate Go worker to run: the Airflow worker forks the bundle binary once per task instance.
213216

@@ -533,8 +536,8 @@ All ``kwargs`` in the ``coordinators`` config entry are passed to the
533536

534537
* Leave ``dag_bundle_name`` unset (the default) to load bundles from the **task's own** Dag bundle,
535538
pinned to the version the run was created with.
536-
* Set ``dag_bundle_name`` to load bundles from a separate Dag bundle. The task uses the version that Dag
537-
bundle is on when it starts, pinned for the whole task.
539+
* Set ``dag_bundle_name`` to load bundles from a separate Dag bundle.
540+
The task uses the version that Dag bundle is on when it starts, pinned for the whole task.
538541

539542
.. _go-sdk/limitations:
540543

‎airflow-core/docs/authoring-and-scheduling/language-sdks/java.rst‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,8 @@ Configure Airflow so the parent JAR directory is a Dag bundle, the coordinator s
274274
}
275275
queue_to_coordinator = {"java": "java"}
276276
277-
``dag_bundle_name`` names the Dag bundle that holds the JARs. You can instead omit it and ship the JARs in the same Dag bundle as ``sales_pipeline.py``.
277+
``dag_bundle_name`` names the Dag bundle that holds the JARs.
278+
You can instead omit it and ship the JARs in the same Dag bundle as ``sales_pipeline.py``.
278279

279280
``java`` is a user-chosen coordinator name, not a reserved value. The value assigned to the queue in
280281
``queue_to_coordinator`` must match a key in ``coordinators``.
@@ -1083,10 +1084,10 @@ All ``kwargs`` in the ``coordinators`` config entry are passed to the
10831084

10841085
**Locating JARs.** JARs always live in a Dag bundle:
10851086

1086-
* Leave ``dag_bundle_name`` unset (the default) to load JARs from the **task's own** Dag bundle, pinned
1087-
to the version the run was created with.
1088-
* Set ``dag_bundle_name`` to load JARs from a separate Dag bundle. The task uses the version that bundle
1089-
is on when it starts, pinned for the whole task.
1087+
* Leave ``dag_bundle_name`` unset (the default) to load JARs from the **task's own** Dag bundle,
1088+
pinned to the version the run was created with.
1089+
* Set ``dag_bundle_name`` to load JARs from a separate Dag bundle.
1090+
The task uses the version that bundle is on when it starts, pinned for the whole task.
10901091

10911092
.. note::
10921093

‎airflow-core/docs/authoring-and-scheduling/language-sdks/typescript.rst‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,10 @@ variables):
238238
}
239239
queue_to_coordinator = {"typescript": "ts"}
240240
241-
``dag_bundle_name`` names the Dag bundle the coordinator scans for ``*.min.mjs`` bundles. Omit it to ship the bundles in the same Dag bundle as the Python stub Dag. ``queue_to_coordinator`` routes stub tasks with ``queue="typescript"`` to this coordinator. See :ref:`typescript-sdk/coordinator-config` for the full list of accepted ``kwargs``.
241+
``dag_bundle_name`` names the Dag bundle the coordinator scans for ``*.min.mjs`` bundles.
242+
Omit it to ship the bundles in the same Dag bundle as the Python stub Dag.
243+
``queue_to_coordinator`` routes stub tasks with ``queue="typescript"`` to this coordinator.
244+
See :ref:`typescript-sdk/coordinator-config` for the full list of accepted ``kwargs``.
242245

243246
There is no separate Node.js worker to run: the Airflow worker launches the bundle with ``node`` once per
244247
task instance.
@@ -560,8 +563,8 @@ All ``kwargs`` in the ``coordinators`` config entry are passed to the
560563

561564
* Leave ``dag_bundle_name`` unset (the default) to load the bundle from the **task's own** Dag bundle,
562565
pinned to the version the run was created with.
563-
* Set ``dag_bundle_name`` to load the bundle from a separate Dag bundle. The task uses the version that Dag
564-
bundle is on when it starts, pinned for the whole task.
566+
* Set ``dag_bundle_name`` to load the bundle from a separate Dag bundle.
567+
The task uses the version that Dag bundle is on when it starts, pinned for the whole task.
565568

566569
Limitations
567570
-----------

‎go-sdk/README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,9 @@ the full range of task states, and alternate XCom backends without implementing
292292
queue_to_coordinator = {"golang": "go"}
293293
```
294294

295-
`dag_bundle_name` names the Dag bundle the coordinator scans for executable bundles. Omit it to ship them in the same Dag bundle as the Python stub Dag. `queue_to_coordinator` routes stub tasks with `queue="golang"` to this Go coordinator.
295+
`dag_bundle_name` names the Dag bundle the coordinator scans for executable bundles.
296+
Omit it to ship them in the same Dag bundle as the Python stub Dag.
297+
`queue_to_coordinator` routes stub tasks with `queue="golang"` to this Go coordinator.
296298

297299
> [!IMPORTANT]
298300
> The coordinator is part of the Airflow worker, so the `[sdk]` config (and the executable bundle

‎java-sdk/README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,8 @@ Now `cd example` into the example project, and
120120
export AIRFLOW__SDK__QUEUE_TO_COORDINATOR='{"java": "java"}'
121121
```
122122

123-
`dag_bundle_name` names the Dag bundle that holds the JARs, here `build/bundle`, outside the Dags folder. Omit it to ship the JARs in the same Dag bundle as the stub Dag.
123+
`dag_bundle_name` names the Dag bundle that holds the JARs, here `build/bundle`, outside the Dags folder.
124+
Omit it to ship the JARs in the same Dag bundle as the stub Dag.
124125

125126
* Ensure the Connection and Variable needed by the example DAG are available:
126127

‎ts-sdk/README.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,9 @@ coordinators = {
9898
queue_to_coordinator = {"typescript": "ts"}
9999
```
100100

101-
The stub Dag's own Dag bundle is searched recursively for `*.min.mjs` bundles built with `airflow-ts-pack`
102-
(see [Packing bundles](#packing-bundles)), which embeds the Airflow metadata in the bundle itself. To keep
103-
the `*.min.mjs` bundles in a separate Dag bundle, set `dag_bundle_name` to a bundle configured in
104-
`[dag_processor] dag_bundle_config_list`.
101+
The stub Dag's own Dag bundle is searched recursively for `*.min.mjs` bundles built with `airflow-ts-pack` (see [Packing bundles](#packing-bundles)),
102+
which embeds the Airflow metadata in the bundle itself. To keep the `*.min.mjs` bundles in a separate Dag bundle,
103+
set `dag_bundle_name` to a bundle configured in `[dag_processor] dag_bundle_config_list`.
105104

106105
TypeScript entrypoint:
107106

‎ts-sdk/example/README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@ export AIRFLOW__SDK__COORDINATORS='{
8383
export AIRFLOW__SDK__QUEUE_TO_COORDINATOR='{"typescript": "ts"}'
8484
```
8585

86-
`dag_bundle_name` names the Dag bundle that holds the bundle, here `dist/`, outside the Dags folder. Omit it to copy the bundle into the same Dag bundle as the stub Dags.
86+
`dag_bundle_name` names the Dag bundle that holds the bundle, here `dist/`, outside the Dags folder.
87+
Omit it to copy the bundle into the same Dag bundle as the stub Dags.
8788

8889
Copy both files in `dags/` into your Airflow Dags folder.
8990

0 commit comments

Comments
 (0)