This is an automated email from the ASF dual-hosted git repository.
jason810496 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 f727ea8544d Fix stale TypeScript SDK docs on bundle metadata and
packing setup (#72115)
f727ea8544d is described below
commit f727ea8544d1b0b7759e78e5dfcb257dd8292957
Author: Jyun-An Chen <[email protected]>
AuthorDate: Thu Aug 27 11:12:45 2026 +0800
Fix stale TypeScript SDK docs on bundle metadata and packing setup (#72115)
The NodeCoordinator config table still described bundles_root as
accepting a bundle.mjs with an airflow-metadata.yaml sidecar, but that
fallback was removed in #70273 and the coordinator now only reads
metadata embedded in the bundle by airflow-ts-pack. The packing section
also jumped straight to running airflow-ts-pack without showing that
apache-airflow-ts-sdk and its optional esbuild peer dependency need to
be installed first, so following the doc as written fails.
---
.../authoring-and-scheduling/language-sdks/typescript.rst | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)
diff --git
a/airflow-core/docs/authoring-and-scheduling/language-sdks/typescript.rst
b/airflow-core/docs/authoring-and-scheduling/language-sdks/typescript.rst
index 205cf629635..279092c5dab 100644
--- a/airflow-core/docs/authoring-and-scheduling/language-sdks/typescript.rst
+++ b/airflow-core/docs/authoring-and-scheduling/language-sdks/typescript.rst
@@ -53,6 +53,11 @@ Prerequisites
the worker, under a directory the coordinator scans.
* The ``apache-airflow-task-sdk`` package (installed with Airflow) provides
the coordinator; no additional
Python packages are needed.
+* In the TypeScript project, install the ``apache-airflow-ts-sdk`` npm package
to author task handlers:
+
+ .. code-block:: bash
+
+ npm install apache-airflow-ts-sdk
Quick start
-----------
@@ -259,8 +264,12 @@ a single self-contained ESM file, ``bundle.mjs``, and
embeds the manifest (the `
map plus the supervisor schema version) as a leading ``//#
airflowMetadata=<base64>`` comment — one file to
deploy, with no separate manifest or ``node_modules``.
+``esbuild`` is an optional peer dependency: packing is build-time only, so the
runtime install of
+``apache-airflow-ts-sdk`` skips it, and it must be installed separately before
running ``airflow-ts-pack``.
+
.. code-block:: bash
+ npm install --save-dev esbuild
npx airflow-ts-pack src/main.ts --outdir dist
Use ``--outdir <dir>`` to choose the output directory (default ``dist``) and
``--source <name>`` to set the
@@ -290,8 +299,8 @@ All ``kwargs`` in the ``coordinators`` config entry are
passed to the
- Description
* - ``bundles_root``
- *(required)*
- - One or more directories searched, in order, for a ``bundle.mjs`` (with
embedded metadata, or with an
- ``airflow-metadata.yaml`` sidecar). Accepts a string, a path, or a list
of strings/paths.
+ - One or more directories searched, in order, for a ``bundle.mjs`` with
embedded metadata. Accepts a
+ string, a path, or a list of strings/paths.
* - ``node_executable``
- ``"node"``
- Path to the ``node`` binary. Defaults to ``node`` on ``$PATH``.
