Skip to content

docs: state that only express is linked with core for releases #200

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
Bccorb merged 1 commit into from
Oct 7, 2026
Merged

docs: state that only express is linked with core for releases #200

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
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---
Expand Down
14 changes: 8 additions & 6 deletions RELEASES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading