From 2bcc619877435df9b45610207e5155ccaedfef35 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Tue, 3 Mar 2026 14:39:29 -0800 Subject: [PATCH 1/3] chore: Update release instructions --- PUBLISHING_JS.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/PUBLISHING_JS.md b/PUBLISHING_JS.md index 428f9fd7e..da0db4a31 100644 --- a/PUBLISHING_JS.md +++ b/PUBLISHING_JS.md @@ -1,23 +1,23 @@ -# Publishing Guide +# JS SDK Release -This document explains how to publish the Braintrust JavaScript SDK to npm. +## Prerelease Instructions -## Pre-Release Versions (Recommended) +- Go to [JS SDK release workflow](https://github.com/braintrustdata/braintrust-sdk-javascript/actions/workflows/publish-js-sdk.yaml) +- Click `Run Workflow` +- Pick which branch you want to pre-release and run workflow to pre-release JS SDK version + - When creating a pre-release off a non-main branch, ensure your branch is up to date with main. -The easiest way to publish is using pre-releases. This doesn't require updating `package.json` or creating git tags. +## Release Instructions -### Quick Start +- Cut a PR that bumps version number in https://github.com/braintrustdata/braintrust-sdk/blob/main/js/package.json#L3 according to [SEMVER](https://semver.org/) principles (e.g., `0.4.3` → `0.4.4`). +- Make sure the tests & integration tests PR pass. +- Merge to main in `braintrust-sdk-javascript` and `braintrust` repos. +- In the `braintrust-sdk-javascript` repo, check out the correct commit and verify you are in a sane state to release code. -Use Github Actions UI -> Publish JS SDK. + ```bash + make release-js-sdk + ``` -## Stable Releases - -For stable releases (published to `@latest`): - -1. Update version in `js/package.json` (e.g., `0.4.3` → `0.4.4`) -2. Commit to `main` branch -3. Run: - ```bash - make release-js-sdk - ``` -4. Confirm when prompted - this creates a git tag and triggers GitHub Actions +- This creates a git tag and triggers GitHub Actions +- Monitor release at https://github.com/braintrustdata/braintrust-sdk-javascript/actions/workflows/publish-js-sdk.yaml +- Update relevant docs From 05ea0ed3e177ac497c764093c8956fe027452ea4 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Tue, 3 Mar 2026 16:13:00 -0800 Subject: [PATCH 2/3] link --- PUBLISHING_JS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/PUBLISHING_JS.md b/PUBLISHING_JS.md index da0db4a31..06d2643c8 100644 --- a/PUBLISHING_JS.md +++ b/PUBLISHING_JS.md @@ -20,4 +20,4 @@ - This creates a git tag and triggers GitHub Actions - Monitor release at https://github.com/braintrustdata/braintrust-sdk-javascript/actions/workflows/publish-js-sdk.yaml -- Update relevant docs +- Update relevant docs ([internal](https://www.notion.so/braintrustdata/SDK-Release-Process-183f7858028980b8a57ac4a81d74f97c#2f1f78580289807ebf35d5e171832d2a)) From df7710f281f37014069030b14c2c92dc720bc2df Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Tue, 3 Mar 2026 16:46:56 -0800 Subject: [PATCH 3/3] update with what matt said --- PUBLISHING_JS.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/PUBLISHING_JS.md b/PUBLISHING_JS.md index 06d2643c8..a6db27592 100644 --- a/PUBLISHING_JS.md +++ b/PUBLISHING_JS.md @@ -21,3 +21,5 @@ - This creates a git tag and triggers GitHub Actions - Monitor release at https://github.com/braintrustdata/braintrust-sdk-javascript/actions/workflows/publish-js-sdk.yaml - Update relevant docs ([internal](https://www.notion.so/braintrustdata/SDK-Release-Process-183f7858028980b8a57ac4a81d74f97c#2f1f78580289807ebf35d5e171832d2a)) +- Spot check releases: https://www.npmjs.com/package/braintrust +- Run test app at https://github.com/braintrustdata/sdk-test-apps (internal) with `make verify-js`