Prepare TypeScript SDK 1.0.0-beta1 - #71822
Conversation
The first beta needs a publishable unscoped npm identity and consistent release metadata across the SDK, examples, and documentation.
boring-cyborg
Bot
added
area:dev-tools
area:ts-sdk
backport-to-v3-3-test
|
Have you claimed the name yet? We should do that asap to avoid automated typosquatters. (They are probably what caused us issues; we merged the intention to use the |
| is spawned by :class:`~airflow.sdk.coordinators.node.NodeCoordinator` for each task instance. | ||
|
|
||
| The SDK is an ESM-only package that ships from the ``ts-sdk/`` directory of the Airflow repository. It is currently in **alpha** and its API may change. | ||
| The SDK is an ESM-only package that ships from the ``ts-sdk/`` directory of the Airflow repository. Its current version is **1.0.0-beta1**, and its API may change. |
There was a problem hiding this comment.
Let’s save 1.0 for maybe when we get the namespace. I think we can do zero-based versions first.
There was a problem hiding this comment.
Since I just claimed the namespace, then it seems fine to keep as-is it with 1.0 ?
There was a problem hiding this comment.
No I meant let’s reserve 1.0 for potentially migrating to @apache-airflow.
| The SDK is not yet published to npm. To try it today, build it from source in the | ||
| `ts-sdk/ <https://github.com/apache/airflow/tree/main/ts-sdk>`__ directory of the Airflow repository and | ||
| depend on it locally (see ``ts-sdk/example/`` for a working setup). | ||
| The SDK is a beta release. Its API may change in incompatible ways between releases. | ||
|
|
||
| Install the beta package from npm: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| npm install apache-airflow-ts-sdk@1.0.0-beta1 |
There was a problem hiding this comment.
Let’s not change this now. The instructions won’t work until we actually publish.
There was a problem hiding this comment.
IMO, the Airflow core docs will be rebased with 3.4 timeline, but we will release the first TS SDK beta release before 3.4 release (perhaps next week if no one object).
There was a problem hiding this comment.
But at least npm install ... will work after we publish the TS package. Changing this file will be fine at that point. But not before that. This PR should not contain this change.
I just claimed it with |
2 participants
Why
The TypeScript SDK is ready for its first beta under the intended unscoped npm package name, with consistent release metadata and documentation.
What
@apache-airflow/ts-sdktoapache-airflow-ts-sdk.1.0.0-beta1and regenerate their lockfile metadata.betatag and document installing the exact beta version.Was generative AI tooling used to co-author this PR?