From 8d7f4298439f6c7cc5e92745d47ce5b3d1a75a3d Mon Sep 17 00:00:00 2001
From: Parth Sharma <psharma@singlestore.com>
Date: Tue, 7 Jul 2026 14:48:16 +0530
Subject: [PATCH] added Release flow

---
 README.md    |  2 ++
 RELEASING.md | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+)
 create mode 100644 RELEASING.md

diff --git a/README.md b/README.md
index afa5378614..45dfc817bc 100644
--- a/README.md
+++ b/README.md
@@ -159,6 +159,8 @@ const connection = singlestore.createConnection({...});
 
 Contributions are welcome! Please see [Contributing.md](Contributing.md) for details.
 
+For the release flow, see [RELEASING.md](RELEASING.md).
+
 ## Acknowledgments
 
 This project is a fork of [mysql2](https://github.com/sidorares/node-mysql2) by @sidorares. We are grateful for the excellent foundation provided by the MySQL2 project.
diff --git a/RELEASING.md b/RELEASING.md
new file mode 100644
index 0000000000..d76377d921
--- /dev/null
+++ b/RELEASING.md
@@ -0,0 +1,35 @@
+## Releasing
+
+Bump the version in `package.json` and `package-lock.json` on `master`, then push a semver tag (`v*.*.*`). That triggers the [Release](.github/workflows/release.yml) GitHub Action. It runs the full test suite against SingleStore, creates a GitHub release with auto-generated notes, and publishes to npm.
+
+Create and push a release tag:
+
+```bash
+git tag v1.0.0
+git push origin v1.0.0
+```
+
+The tag must match `package.json` (for example version `1.0.0` → tag `v1.0.0`).
+
+Each release publishes `singlestore-nodejs` to npm with:
+
+- `lib/`
+- `typings/mysql/`
+- `index.js`, `index.d.ts`
+- `promise.js`, `promise.d.ts`
+
+To run the same tests locally:
+
+```bash
+export CI=1
+export MYSQL_HOST=127.0.0.1
+export MYSQL_USER=root
+export MYSQL_PASSWORD=
+export MYSQL_DATABASE=test
+
+bash run-all-tests.sh
+```
+
+See [Contributing.md](Contributing.md#running-tests) for SingleStore setup details.
+
+Pull requests run the [Run Tests](.github/workflows/tests.yml) workflow. The [Release](.github/workflows/release.yml) workflow runs the same tests before publishing.