The GitHub Actions job "Tests (AMD)" on 
airflow.git/feature/ts-sdk/typescript-api-docs has succeeded.
Run started by GitHub user jason810496 (triggered by jason810496).

Head commit for run:
72d668b71ade25ebce01a00fed5e873b0ef9efd0 / Jason Liu <[email protected]>
Build the TypeScript SDK API reference with TypeDoc instead of sphinx-js

sphinx-js held the docs toolchain back to TypeDoc 0.25 and TypeScript 5.4 —
several majors behind the TypeScript 6 the SDK itself is built with — and its
comment renderer could not represent TSDoc inline tags, so a bundled TypeDoc
plugin had to flatten every `{@link}` into literal text just to keep the build
from crashing. Both the version cap and the workaround existed only to bridge
TypeScript into Sphinx.

Rendering with TypeDoc directly removes that bridge. The toolchain tracks the
same TypeScript the SDK compiles with, the reference is no longer squeezed
through a hand-maintained RST mirror of the public API that had to be updated
whenever an export changed, and cross-references resolve natively. This follows
the precedent already set by the Java SDK, whose Javadoc is built with Dokka
rather than Sphinx and staged into the same publish pipeline.

The package root is the only entry point given to TypeDoc. It already re-exports
everything `./coordinator` exposes, so listing both produced two navigation
sections that documented one API between them, with no symbol unique to either.

Dropping the Python dependency also releases the constraint it dragged in:
sphinx-js required cattrs < 25, which had pinned the whole workspace back from
cattrs 26.1.0 to 24.1.3. The lock file returns to what main resolves.

Report URL: https://github.com/apache/airflow/actions/runs/31364454434

With regards,
GitHub Actions via GitBox


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to