Uh oh!
There was an error while loading. Please reload this page.
Fix stale TypeScript SDK docs on bundle metadata and packing setup - #72115
Merged
jason810496 merged 1 commit intoAug 27, 2026
Merged
Conversation
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 apache#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.
ColtenOuO
commented
Aug 26, 2026
ContributorAuthor
cc. @jason810496 |
jason810496
approved these changes
Aug 27, 2026
Uh oh!
There was an error while loading. Please reload this page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
airflow-core/docs/authoring-and-scheduling/language-sdks/typescript.rststill describedNodeCoordinator'sbundles_rootas accepting abundle.mjs"with embedded metadata, or with anairflow-metadata.yamlsidecar." That sidecar fallback was removed in #70273 (Remove airflow-metadata.yaml sidecar support from NodeCoordinator) —airflow-ts-packalways embeds the manifest inbundle.mjsitself, andNodeCoordinatornow only reads that embedded metadata; no tool produces the sidecar file, and_bundle_metadata.py's YAML-sidecar parsing helpers are effectively dead code from the doc's point of view. The doc never got updated when the code changed, so it describes a deployment shape (a hand-writtenairflow-metadata.yamlnext to the bundle) that Airflow no longer supports.Separately, the "Building and packaging" section jumped straight to running
npx airflow-ts-pack src/main.ts --outdir distwithout ever showing how to get there: it never mentioned installing theapache-airflow-ts-sdknpm package, and it didn't mention thatesbuild— the bundlerairflow-ts-packuses — is an optional peer dependency that the runtime install intentionally skips (seets-sdk/package.json'speerDependenciesMeta.esbuild.optional). A user following the doc exactly as written would runnpx airflow-ts-packin a project that never hadesbuildinstalled and hit a failure with no explanation in the doc of why, or what to install instead. Thets-sdk/README.mdalready has the correct sequence (npm install --save-dev esbuildbefore packing); the RST doc had drifted from it.Change
airflow-metadata.yamlsidecar mention from theNodeCoordinatorconfiguration table;bundles_rootnow just documents the current, single supported shape (abundle.mjswith embedded metadata).npm install apache-airflow-ts-sdkfor authoring task handlers.npm install --save-dev esbuildto the "Building and packaging" section, before theairflow-ts-packinvocation, so the documented steps actually work end-to-end for a fresh project.Docs-only change.
Was generative AI tooling used to co-author this PR?