Skip to content

Added Release flow #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
psharma-1909 merged 1 commit into from
Jul 7, 2026
Merged

Added Release flow #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
35 changes: 35 additions & 0 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading