Skip to content

RELEASES.md

Latest commit

 

History

History
56 lines (41 loc) · 2.08 KB

RELEASES.md

File metadata and controls

56 lines (41 loc) · 2.08 KB
Raw

Release Management

This repo uses pnpm workspaces plus Changesets.

Package Graph

  • @seamless-auth/core is the framework-agnostic package.
  • @seamless-auth/express depends on @seamless-auth/core through workspace:^ during local development.
  • When packages are packed or published, pnpm rewrites workspace:^ to the released semver range, so adapters can be tested against local core changes before core exists on npm.

Daily Development

  1. Make the code change.
  2. Run pnpm changeset.
  3. Select the package or packages that have adopter-facing changes.
  4. Choose the semver bump.
  5. Write release notes for adopters, not implementation notes.

Channels

  • alpha: manual prerelease snapshots from the Prerelease workflow.
  • beta: automatic snapshots from dev.
  • rc: automatic snapshots from release/** branches.
  • latest: stable releases from main through the Release workflow.

Prerelease snapshots publish to npm dist-tags without Git tags. Stable releases publish to npm, create package Git tags, and create GitHub Releases from the changeset summaries.

Pre-1.0 Policy

@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 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 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.
  • add new adapters only after they pass the shared conformance suite for the current known-good core version.