Skip to content

Add TypeScript SDK guide to language SDKs docs#70219

Merged
jason810496 merged 6 commits into
apache:mainfrom
jason810496:docs/ts-sdk/typescript-language-sdk-doc
Jul 24, 2026
Merged

Add TypeScript SDK guide to language SDKs docs#70219
jason810496 merged 6 commits into
apache:mainfrom
jason810496:docs/ts-sdk/typescript-language-sdk-doc

Conversation

@jason810496

Copy link
Copy Markdown
Member

Why

The Non-Python Task SDKs docs cover the Java and Go SDKs, but the TypeScript SDK (ts-sdk/, launched by NodeCoordinator) has no guide and is missing from the language-SDKs index.

What

  • Add airflow-core/docs/authoring-and-scheduling/language-sdks/typescript.rst following the same structure as the existing go.rst / java.rst: prerequisites, quick start (Python stub Dag + TypeScript implementation + coordinator config), writing tasks (TaskHandlerArgs, TaskClient surface), logging, XCom type mapping, building and packaging with airflow-ts-pack, NodeCoordinator configuration, and limitations.
  • Register the new page in the language-SDKs index table and toctree.
  • Add esbuild and ESM to docs/spelling_wordlist.txt.

Was generative AI tooling used to co-author this PR?

@jason810496 jason810496 self-assigned this Jul 22, 2026
@jason810496 jason810496 added this to the TS SDK 1.0 Beta milestone Jul 22, 2026
@jason810496
jason810496 force-pushed the docs/ts-sdk/typescript-language-sdk-doc branch from b85a1ee to 66cc73a Compare July 22, 2026 07:50
Comment thread airflow-core/docs/authoring-and-scheduling/language-sdks/typescript.rst Outdated
@jason810496
jason810496 marked this pull request as ready for review July 23, 2026 08:50
@jason810496
jason810496 requested a review from uranusjr July 23, 2026 09:02
jason810496 and others added 5 commits July 23, 2026 21:42
Co-authored-by: Phani Kumar <94376113+phanikumv@users.noreply.github.com>
The warning directive body was not indented under it, so Sphinx found no
content block and the warnings-as-errors docs build failed.
The npm package name is not an official Apache release, so the README should
not instruct users to install it from the registry.
The coordinator reference listed the Java and native-executable coordinators
but not the Node.js one that the TypeScript SDK guide links to.
@jason810496
jason810496 force-pushed the docs/ts-sdk/typescript-language-sdk-doc branch from 24f5154 to fdf3f88 Compare July 23, 2026 13:42
@jason810496
jason810496 requested a review from guan404ming July 23, 2026 13:42

@guan404ming guan404ming left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: LocalExecutor runs tasks inside the scheduler, so "accessible from the worker" in Prerequisites points those users at the wrong process. We could consider add the note go.rst has about where the [sdk] config and bundles need to live

@jason810496
jason810496 requested a review from Copilot July 24, 2026 02:18

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@guan404ming

Copy link
Copy Markdown
Member

Thanks for the update

@jason810496
jason810496 merged commit e0f837b into apache:main Jul 24, 2026
70 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants