Update the build and publish process

.github/workflows/build.yml

@@ -23,16 +23,13 @@ jobs:
         run: |
           npm install -g typescript
 
-      - name: Build Common package
+      - name: Build packages
         run: |
-          npx tsx .build/build_and_prepare.ts common && npm pack
+          npm --workspaces run build
 
-      - name: Build Node.js package
+      - name: Pack packages
         run: |
-          npx tsx .build/build_and_prepare.ts node && npm pack
-      - name: Build Web package
-        run: |
-          npx tsx .build/build_and_prepare.ts web && npm pack
+          npm --workspaces pack
 
       - name: Rename artifacts
         run: |

.gitignore

@@ -10,3 +10,5 @@ out
 coverage
 coverage-web
 .nyc_output
+packages/*/README.md
+packages/*/LICENSE

.scripts/update_version.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+set -euo pipefail
+
+version=${1:-}
+if [ -z "$version" ]; then
+  echo "Usage: $0 <version>"
+  exit 1
+fi
+
+echo "Setting the version to: $version"
+
+for package in packages/client-node packages/client-web; do
+  if [ -f "$package/package.json" ]; then
+    echo "Updating client-common version in $package/package.json"
+    json=$(cat "$package/package.json")
+    echo "$json" | jq --arg version "$version" '.dependencies["@clickhouse/client-common"] = $version' > "$package/package.json"
+  fi
+done
+
+npm --workspaces version "$version"

CONTRIBUTING.md

@@ -214,27 +214,43 @@ See [#177](https://github.com/ClickHouse/clickhouse-js/issues/177), as it should
 
 ## Release process
 
-Don't forget to change the package version in `packages/**/src/version.ts` before the release.
+Tools required:
+
+- Node.js >= `20.x`
+- NPM >= `11.x`
+- jq (https://stedolan.github.io/jq/)
+
 We prefer to keep versions the same across the packages, and release all at once, even if there were no changes in some.
 
-Common package manual release:
+Make sure that the working directory is clean:
 
 ```bash
-npx tsx .build/build_and_prepare.ts common && npm pack && npm publish
+git clean -dfX
+npm i
 ```
 
-Node.js client manual release:
+```bash
+.scripts/update_version.sh [new_version]
+```
+
+Then build the packages:
 
 ```bash
-npx tsx .build/build_and_prepare.ts node && npm pack && npm publish
+npm --workspaces run build
 ```
 
-Web client manual release:
+Now we're ready to publish.
 
 ```bash
-npx tsx .build/build_and_prepare.ts web && npm pack && npm publish
+npm --workspaces pack
+npm --workspaces publish
 ```
 
-For simplicity, `build_and_prepare.ts` just overrides the root `package.json`,
-which allows to use `npm pack` and `npm publish` as usual despite having multiple workspaces.
-Don't commit the generated `package.json` after the manual release.
+After that you can commit the changes, create a new Git tag and push it to the repository:
+
+```bash
+git add .
+git commit -m "chore: bump version to [new_version]"
+git tag v[new_version]
+git push origin v[new_version]
+```

package.json

@@ -2,7 +2,7 @@
   "name": "clickhouse-js",
   "description": "Official JS client for ClickHouse DB",
   "homepage": "https://clickhouse.com",
-  "version": "0.0.0",
+  "version": "1.15.0",
   "license": "Apache-2.0",
   "keywords": [
     "clickhouse",
@@ -19,9 +19,6 @@
   },
   "scripts": {
     "build:node:all": "rm -rf out; tsc --project tsconfig.all.json",
-    "build:common:package": ".scripts/build.sh client-common",
-    "build:node:package": ".scripts/build.sh client-node",
-    "build:web:package": ".scripts/build.sh client-web",
     "build:web:minjs": "webpack --config webpack.release.js",
     "typecheck": "tsc --project tsconfig.all.json --noEmit",
     "lint": "eslint .",

packages/client-common/package.json

@@ -2,7 +2,7 @@
   "name": "@clickhouse/client-common",
   "description": "Official JS client for ClickHouse DB - common types",
   "homepage": "https://clickhouse.com",
-  "version": "0.0.0",
+  "version": "1.15.0",
   "license": "Apache-2.0",
   "keywords": [
     "clickhouse",
@@ -19,6 +19,10 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "prepack": "cp ../../README.md ../../LICENSE .",
+    "build": "rm -rf dist; tsc"
+  },
   "dependencies": {},
   "devDependencies": {}
 }

packages/client-common/src/client.ts

@@ -9,12 +9,8 @@ import type {
   MakeResultSet,
   WithClickHouseSummary,
   WithResponseHeaders,
-} from '@clickhouse/client-common'
-import {
-  type DataFormat,
-  defaultJSONHandling,
-  DefaultLogger,
-} from '@clickhouse/client-common'
+} from './index'
+import { type DataFormat, defaultJSONHandling, DefaultLogger } from './index'
 import type { InsertValues, NonEmptyArray } from './clickhouse_types'
 import type { ImplementationDetails, ValuesEncoder } from './config'
 import { getConnectionParams, prepareConfigWithURL } from './config'

packages/client-common/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["./src/**/*.ts"],
+  "compilerOptions": {
+    "outDir": "./dist"
+  }
+}

packages/client-node/package.json

@@ -2,7 +2,7 @@
   "name": "@clickhouse/client",
   "description": "Official JS client for ClickHouse DB - Node.js implementation",
   "homepage": "https://clickhouse.com",
-  "version": "0.0.0",
+  "version": "1.15.0",
   "license": "Apache-2.0",
   "keywords": [
     "clickhouse",
@@ -22,8 +22,12 @@
   "files": [
     "dist"
   ],
+  "scripts": {
+    "prepack": "cp ../../README.md ../../LICENSE .",
+    "build": "rm -rf dist; tsc"
+  },
   "dependencies": {
-    "@clickhouse/client-common": "*"
+    "@clickhouse/client-common": "1.15.0"
   },
   "devDependencies": {
     "simdjson": "^0.9.2"

packages/client-node/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["./src/**/*.ts"],
+  "compilerOptions": {
+    "outDir": "./dist"
+  }
+}