From a02090b70f405fc2cec60080d583e3790da2233a Mon Sep 17 00:00:00 2001 From: Brandon Corbett Date: Tue, 6 Oct 2026 23:46:17 -0400 Subject: [PATCH] docs: state that only express is linked with core for releases README.md and RELEASES.md said the core and official JavaScript adapters are linked in .changeset/config.json. The config links only @seamless-auth/core and @seamless-auth/express; @seamless-auth/fastify and @seamless-auth/nextjs release on their own versions. Reword both files to describe the actual policy, and adjust the RELEASES.md pre-1.0 and after-v1 bullets so they refer to express rather than all adapters. The changeset config is unchanged; whether to link the other adapters is a separate release-policy decision. Closes #195 --- README.md | 5 +++-- RELEASES.md | 14 ++++++++------ 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 11ec3b4..a9f5638 100644 --- a/README.md +++ b/README.md @@ -275,8 +275,9 @@ This repository uses pnpm workspaces and Changesets for package releases. Published from `main`. Changesets opens a version PR, then publishes npm packages, Git tags, changelogs, and GitHub Releases when that PR is merged. -The core and official JavaScript adapters are linked while the API is pre-1.0 -so adopters can treat releases as a known-good set. See `RELEASES.md` for the +`@seamless-auth/core` and `@seamless-auth/express` are linked while the API is +pre-1.0 so adopters can treat them as a known-good set. `@seamless-auth/fastify` +and `@seamless-auth/nextjs` version independently. See `RELEASES.md` for the release policy. --- diff --git a/RELEASES.md b/RELEASES.md index ee57873..12adb27 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -32,21 +32,23 @@ changeset summaries. ## Pre-1.0 Policy -The core and official JavaScript adapters are linked in `.changeset/config.json` -so they move as a known-good set while the API is still settling. +`@seamless-auth/core` and `@seamless-auth/express` are linked in +`.changeset/config.json` so they move as a known-good set while the API is still +settling. `@seamless-auth/fastify` and `@seamless-auth/nextjs` are not in the +linked group and version independently. Recommended pre-1.0 behavior: -- core behavior changes: bump core and publish linked adapters. -- adapter-only fixes: bump the adapter; linked packages keep the release train - visible. +- core behavior changes: bump core and publish express with it. +- adapter-only fixes: bump the adapter. For express, the link keeps the release + train with core visible; fastify and nextjs move on their own versions. - breaking API changes before v1: use a minor bump and clear release notes. ## After v1 Once `@seamless-auth/core` and `@seamless-auth/express` are stable: -- remove adapters from the linked Changesets group when independent versioning +- remove express from the linked Changesets group when independent versioning becomes valuable. - keep adapters compatible with `@seamless-auth/core@^1` unless a core major requires a coordinated adapter major.