Quickstart - Spree Commerce documentation

Keeping your Spree installation up-to-date is essential to keep it safe and secure. Each Spree version brings new features, enhancements and bug fixes so it’s greatly beneficial for you and your clients to upgrade frequently. The upgrade process is fairly easy and well described. Of course, it all boils down to the level of customizations and the way you’ve customized your Spree applications. We strongly advise upgrading Spree incrementally, rather than in one big go.

How to upgrade

An upgrade updates the server and the @spree/* packages of your dashboard apps, migrates the database, and runs the version’s data backfills. Always read the guide for the version you’re moving to first — it lists the behavior changes to review.

Spree CLI
Without CLI

spree upgrade

One command for every project: it pulls the new image, or updates the Spree gems on an ejected project, then updates the packages and runs migrations and data backfills. See spree upgrade for its options.

Run from the project root:

(cd server && bundle update $(bundle list --name-only | grep ^spree))

# The project root and each dashboard app have their own package.json
pnpm update "@spree/*"
(cd apps/dashboard && pnpm update "@spree/*")
(cd apps/seller-dashboard && pnpm update "@spree/*")

cd server
bin/rails spree:install:migrations db:migrate
bin/rails spree:upgrade

On npm or Yarn, run npm update or yarn upgrade instead, naming each @spree/* package from that package.json (they do not accept the "@spree/*" pattern).

Support

If you’re stuck and would want to get some professional help, you can contact us directly and request a quote for our consulting services.

Release types

Spree development follows a shifted version of Semantic Versioning: Patch Z, eg. 4.2.1 Only bug fixes, no API changes, no new features. Except as necessary for security fixes. Minor Y, eg. 4.2.0 New features, may contain API changes Serve as major versions of Semver. Breaking changes are paired with deprecation notices in the previous minor or major release. Major X, eg. 4.0.0 New features, will likely contain API changes. The difference between Spree minor and major releases is the magnitude of breaking changes and is usually reserved for special occasions.

Security

Our Security policy is described here. When a release series is no longer supported, it’s your own responsibility to deal with bugs and security issues. We may provide backports of some critical security fixes.

​How to upgrade

​Support

​Release types

​Security

How to upgrade

Support

Release types

Security