Skip to content

Versioning

OpenShop is currently beta. Until 1.0, minor or prerelease updates can change public TypeScript APIs, configuration, generated template files, database migrations, CLI behavior, and documented workflows.

  • Applications should pin an exact OpenShop version while evaluating an update.
  • Commit pnpm-lock.yaml and generated migrations.
  • Deploy web and worker from the same lockfile and build.
  • Do not assume openshop init updates an existing project.

The package version used to generate a project and the dependency written into that project’s package.json must refer to a published compatible release. OpenShop’s smoke tests should scaffold into an empty directory, install, lint, test, and build the result before publication.

Surface Compatibility check
TypeScript SDK Run type-checking and application tests.
Generated template Compare scripts, aliases, TOML, Docker, PM2, and Drizzle files.
Configuration Start the app so runtime validation checks registered names and positive numeric options.
Database Generate and review SQL; test forward migration and application rollback compatibility.
GraphQL codegen Regenerate operations against the configured Shopify API schema.
Web and worker Deploy the exact same package and config version.

See Upgrade OpenShop for the step-by-step procedure.