Skip to content

Commit

Permalink
Add notes on releasing jsapi-types
Browse files Browse the repository at this point in the history
Note that this isn't yet part of CI, either for nightly builds or for
tagged releases.
  • Loading branch information
niloc132 committed Nov 28, 2023
1 parent de0e134 commit 7e460d0
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 4 deletions.
7 changes: 6 additions & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,11 @@ and are published as the following:
* [C++ Client API](https://deephaven.io/core/client-api/cpp/)
* [C++ Examples](https://deephaven.io/core/client-api/cpp-examples/)
* [R Client API](https://deephaven.io/core/client-api/r/)
* [TypeScript Client API](https://deephaven.io/core/client-api/javascript/)
* [JavaScript/TypeScript Client API](https://deephaven.io/core/client-api/javascript/)

### 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

Expand Down Expand Up @@ -265,6 +269,7 @@ mention the version explicitly. These files are listed below:
#
gradle.properties
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
Expand Down
3 changes: 2 additions & 1 deletion web/client-api/types/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions web/client-api/types/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -24,4 +24,4 @@
"publishConfig": {
"access": "public"
}
}
}

0 comments on commit 7e460d0

Please sign in to comment.