This guide covers upgrading a 3.0.x Spree store, to a 3.1.x store. This guide has been written from the perspective of a blank Spree 3.0.x store with no extensions.

If you have extensions that your store depends on, you will need to manually verify that each of those extensions work within your 3.1.x store once this upgrade is complete. Typically, extensions that are compatible with this version of Spree will have a 3-1-stable branch.

Upgrade Rails

For this Spree release, you will need to upgrade your Rails version to at least 4.2.6.

gem 'rails', '~> 4.2.6'

Upgrade Spree

For best results, use the spree gem in version 3.1.x:

gem 'spree', '~> 3.1.0.rc1'

Run bundle update spree.

Copy and run migrations

Copy over the migrations from Spree (and any other engine) and run them using these commands:

rake railties:install:migrations
rake db:migrate

Spree Auth Devise & Spree Gateway

If you are using Spree Gateway and/or Spree Auth Devise you should also upgrade them:

gem 'spree_auth_devise', '~> 3.1.0.rc1'
gem 'spree_gateway', '~> 3.1.0.rc1'

For Spree Auth Devise run installer:

rails g spree:auth:install

(you don’t have to override config/initializers/devise.rb)

Additional information

Make sure to v1 namespace custom rabl templates & overrides.

If your rabl templates reference others with extend you’ll need to add the v1 namespace.

For example:

extends 'spree/api/zones/show'

Becomes:

extends 'spree/api/v1/zones/show'

Remove Spree::Config.check_for_spree_alerts

If you were disabling the alert checks you’ll now want to remove this preference as it’s no longer used.

Read the release notes

For information about changes contained within this release, please read the 3.1.0 Release Notes.

Verify that everything is OK

Run you test suite, click around in your store and make sure it’s performing as normal. Fix any deprecation warnings you see.