From 024651ecbf8bad4838f11f60af97a2ab18d6cafa Mon Sep 17 00:00:00 2001 From: Colin Alworth Date: Tue, 28 Nov 2023 11:28:08 -0600 Subject: [PATCH] Add notes on releasing jsapi-types Note that this isn't yet part of CI, either for nightly builds or for tagged releases. --- RELEASE.md | 5 +++++ web/client-api/types/package-lock.json | 3 ++- web/client-api/types/package.json | 4 ++-- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 3bc643c6d78..ea47ac0307b 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -54,6 +54,10 @@ The Deephaven python client is released as the `pydeephaven` wheel at [PyPi](htt ### Deephaven go client The Deephaven go client is released as a [Go package](https://pkg.go.dev/github.com/deephaven/deephaven-core/go). +### Deephaven JS API types +The npm package `@deephaven/jsapi-types` allow TypeScript clients to use their IDE's autocomplete and compiler's typechecks. +It is released to [npm](https://www.npmjs.com/package/@deephaven/jsapi-types). + ## Release process The majority of the release procedure is controlled through the [publish-ci.yml workflow](./.github/workflows/publish-ci.yml). @@ -260,6 +264,7 @@ py/client/setup.py py/embedded-server/deephaven_server/__init__.py py/server/deephaven/__init__.py R/rdeephaven/DESCRIPTION +web/client-api/types/package.json ``` This leaves the files "ready" for the next regular release, and also ensures any build done from diff --git a/web/client-api/types/package-lock.json b/web/client-api/types/package-lock.json index 1a1b22d96b1..1240b4d3984 100644 --- a/web/client-api/types/package-lock.json +++ b/web/client-api/types/package-lock.json @@ -92,5 +92,6 @@ "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", "dev": true } - } + }, + "version": "1.0.0-dev0.31.0" } diff --git a/web/client-api/types/package.json b/web/client-api/types/package.json index ce87d6d3acb..af3960d094b 100644 --- a/web/client-api/types/package.json +++ b/web/client-api/types/package.json @@ -1,6 +1,6 @@ { "name": "@deephaven/jsapi-types", - "version": "1.0.0-dev1", + "version": "1.0.0-dev0.31.0", "description": "Deephaven JSAPI Types", "author": "Deephaven Data Labs LLC", "license": "Apache-2.0", @@ -24,4 +24,4 @@ "publishConfig": { "access": "public" } -} \ No newline at end of file +}