Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Feature/docs upgrade guides 2 (#12025)

Damian Legawiece806a5c2d746
diff --git a/common_spree_dependencies.rb b/common_spree_dependencies.rb
index 24daae1c5d..3068499806 100644
--- a/common_spree_dependencies.rb
+++ b/common_spree_dependencies.rb
@@ -22,7 +22,7 @@ platforms :ruby do
elsif ENV['DB'] == 'postgres'
gem 'pg'
else
- gem 'sqlite3'
+ gem 'sqlite3', '~> 1.4'
end
end
diff --git a/docs/developer/core-concepts/taxes.mdx b/docs/developer/core-concepts/taxes.mdx
index b91ad9fff2..f6eb6d26a3 100644
--- a/docs/developer/core-concepts/taxes.mdx
+++ b/docs/developer/core-concepts/taxes.mdx
@@ -1,10 +1,11 @@
---
title: Taxes
+description: Learn how to configure taxes in Spree
---
-## Overview
-Spree represents taxes for an order by using `tax_categories` and `tax_rates`.
+
+Spree represents taxes for an order by using Tax Categories and `tax_rates`.
Products within Spree can be linked to Tax Categories, which are then used to influence the taxation rate for the products when they are purchased. One Tax Category can be set to being the default for the entire system, which means that if a product doesn't have a related tax category, then this default tax category would be used.
@@ -61,7 +62,11 @@ We may also reduce the order total by the tax amount if the order is being shipp
Most tax jurisdictions base the tax on the shipping address of where the order is being shipped to. So in these cases the shipping address is used when determining the tax zone. Spree does, however, allow you to use the billing address to determine the zone.
-To determine tax based on billing address instead of shipping address you will need to set the `Spree::Config[:tax_using_ship_address]` preference to `false`.
+To determine tax based on billing address instead of shipping address you will need to add this line to your `config/initializers/spree.rb`
+
+```ruby
+Spree::Config[:tax_using_ship_address] = false
+```
`Spree::Zone.match` is a method used to determine the most applicable zone for taxation. In the case of multiple matches, the closer match will be used, with State zone matches having priority over Country zone matches.
diff --git a/docs/developer/upgrades/two-dot-oh-to-two-dot-one.mdx b/docs/developer/upgrades/2.0-to-2.1.mdx
similarity index 78%
rename from docs/developer/upgrades/two-dot-oh-to-two-dot-one.mdx
rename to docs/developer/upgrades/2.0-to-2.1.mdx
index 074dadff4a..8664b5768d 100644
--- a/docs/developer/upgrades/two-dot-oh-to-two-dot-one.mdx
+++ b/docs/developer/upgrades/2.0-to-2.1.mdx
@@ -1,13 +1,8 @@
---
title: 2.0 to 2.1
-section: upgrades
-order: 12
-hidden: true
description: 'This guide covers upgrading a 2.0 Spree store, to a 2.1 store.'
---
-# 2.0 to 2.1
-
## Overview
This guide has been written from the perspective of a blank Spree 2.0 store with no extensions.
@@ -23,14 +18,16 @@ For this Spree release, you will need to upgrade your Rails version to at least
It is recommended to read through the [Upgrading Ruby on Rails guide](http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-%20from-rails-3-2-to-rails-4-0) to learn what needs to be done for your application to migrate to Rails 4.
```ruby
-gem 'rails', '~> 4.0'```
+gem 'rails', '~> 4.0'
+```
## Upgrade Spree
For best results, use the 2-1-stable branch from GitHub:
```ruby
-gem 'spree', github: 'spree/spree', branch: '2-1-stable'```
+gem 'spree', '~> 2.1'
+```
Run `bundle update spree`.
@@ -39,15 +36,11 @@ Run `bundle update spree`.
Copy over the migrations from Spree (and any other engine) and run them using
these commands:
+```bash
rake railties:install:migrations
rake db:migrate
+```
## Read the release notes
-For information about changes contained with this release, please read the [2.1.0 Release Notes](http://guides.spreecommerce.org/release_notes/spree_2_1_0.html).
-
-## Verify that everything is OK
-
-Click around in your store and make sure it's performing as normal. Fix any deprecation warnings you see.
-```
-
+For information about changes contained with this release, please read the [2.1.0 Release Notes](https://github.com/spree/spree/releases/tag/v2.1.0).
\ No newline at end of file
diff --git a/docs/developer/upgrades/two-dot-one-to-two-dot-two.mdx b/docs/developer/upgrades/2.1-to-2.2.mdx
similarity index 85%
rename from docs/developer/upgrades/two-dot-one-to-two-dot-two.mdx
rename to docs/developer/upgrades/2.1-to-2.2.mdx
index 0d9f82791d..8481ef0c14 100644
--- a/docs/developer/upgrades/two-dot-one-to-two-dot-two.mdx
+++ b/docs/developer/upgrades/2.1-to-2.2.mdx
@@ -1,12 +1,9 @@
---
title: 2.1 to 2.2
section: upgrades
-order: 11
-hidden: true
description: 'This guide covers upgrading a 2.1 Spree store, to a 2.2 store.'
---
-# 2.1 to 2.2
## Overview
@@ -27,7 +24,8 @@ gem 'rails', '~> 4.0.6'
For best results, use the 2-2-stable branch from GitHub:
```ruby
-gem 'spree', github: 'spree/spree', branch: '2-2-stable'```
+gem 'spree', '~> 2.2'
+```
Run `bundle update spree`.
@@ -36,8 +34,13 @@ Run `bundle update spree`.
Copy over the migrations from Spree (and any other engine) and run them using
these commands:
- rake railties:install:migrations
- rake db:migrate
+```bash
+rake railties:install:migrations
+```
+
+```bash
+rake db:migrate
+```
## Read the release notes
@@ -56,8 +59,5 @@ This applies across the board on Spree, and may need to be done in your store's
Please consult [this section](http://guides.spreecommerce.org/release_notes/spree_2_2_0.html#paperclip-settings-have-been-removed) of the release notes if you were using custom Paperclip settings. This will direct you what to do in that particular case.
-## Verify that everything is OK
-Click around in your store and make sure it's performing as normal. Fix any deprecation warnings you see.
-```
diff --git a/docs/developer/upgrades/two-dot-two-to-two-dot-three.mdx b/docs/developer/upgrades/2.2-to-2.3.mdx
similarity index 75%
rename from docs/developer/upgrades/two-dot-two-to-two-dot-three.mdx
rename to docs/developer/upgrades/2.2-to-2.3.mdx
index 8ceace3671..8a1fbbb0f7 100644
--- a/docs/developer/upgrades/two-dot-two-to-two-dot-three.mdx
+++ b/docs/developer/upgrades/2.2-to-2.3.mdx
@@ -1,13 +1,8 @@
---
title: 2.2 to 2.3
-section: upgrades
-hidden: true
-order: 10
description: 'This guide covers upgrading a 2.2 Spree store, to a 2.3 store.'
---
-# 2.2 to 2.3
-
## Overview
This guide has been written from the perspective of a blank Spree 2.2 store with no extensions.
@@ -29,7 +24,8 @@ gem 'rails', '~> 4.1.2'
For best results, use the 2-3-stable branch from GitHub:
```ruby
-gem 'spree', github: 'spree/spree', branch: '2-3-stable'```
+gem 'spree', '~> 2.3'
+```
Run `bundle update spree`.
@@ -38,15 +34,11 @@ Run `bundle update spree`.
Copy over the migrations from Spree (and any other engine) and run them using
these commands:
+```bash
rake railties:install:migrations
rake db:migrate
+```
## Read the release notes
-For information about changes contained with this release, please read the [2.3.0 Release Notes](http://guides.spreecommerce.org/release_notes/spree_2_3_0.html).
-
-## Verify that everything is OK
-
-Click around in your store and make sure it's performing as normal. Fix any deprecation warnings you see.
-```
-
+For information about changes contained with this release, please read the [2.3.0 Release Notes](https://github.com/spree/spree/releases/tag/v2.3.0).
diff --git a/docs/developer/upgrades/two-dot-three-to-two-dot-four.mdx b/docs/developer/upgrades/2.3-to-2.4.mdx
similarity index 66%
rename from docs/developer/upgrades/two-dot-three-to-two-dot-four.mdx
rename to docs/developer/upgrades/2.3-to-2.4.mdx
index 0b30998c05..4688a3d8c4 100644
--- a/docs/developer/upgrades/two-dot-three-to-two-dot-four.mdx
+++ b/docs/developer/upgrades/2.3-to-2.4.mdx
@@ -1,13 +1,9 @@
---
title: 2.3 to 2.4
section: upgrades
-hidden: true
-order: 9
description: 'This guide covers upgrading a 2.3 Spree store, to a 2.4 store.'
---
-# 2.3 to 2.4
-
This guide has been written from the perspective of a blank Spree 2.3 store with no extensions.
If you have extensions that your store depends on, you will need to manually verify that each of those extensions works within your 2.4 store once this upgrade is complete. Typically, extensions that are compatible with this version of Spree will have a 2-4-stable branch.
@@ -22,10 +18,9 @@ gem 'rails', '~> 4.1.8'
## Upgrade Spree
-For best results, use the 2-4-stable branch from GitHub:
-
```ruby
-gem 'spree', github: 'spree/spree', branch: '2-4-stable'```
+gem 'spree', '~> 2.4'
+```
Run `bundle update spree`.
@@ -34,15 +29,15 @@ Run `bundle update spree`.
Copy over the migrations from Spree (and any other engine) and run them using
these commands:
- rake railties:install:migrations
- rake db:migrate
-
-## Read the release notes
+```bash
+rake railties:install:migrations
+```
-For information about changes contained within this release, please read the [2.4.0 Release Notes](http://guides.spreecommerce.org/release_notes/spree_2_4_0.html).
+```bash
+rake db:migrate
+```
-## Verify that everything is OK
+## Read the release notes
-Click around in your store and make sure it's performing as normal. Fix any deprecation warnings you see.
-```
+For information about changes contained within this release, please read the [2.4.0 Release Notes](https://github.com/spree/spree/releases/tag/v2.4.0).
diff --git a/docs/developer/upgrades/three-dot-oh-to-three-dot-one.mdx b/docs/developer/upgrades/3.0-to-3.1.mdx
similarity index 78%
rename from docs/developer/upgrades/three-dot-oh-to-three-dot-one.mdx
rename to docs/developer/upgrades/3.0-to-3.1.mdx
index b6e7edad80..bfb1d44637 100644
--- a/docs/developer/upgrades/three-dot-oh-to-three-dot-one.mdx
+++ b/docs/developer/upgrades/3.0-to-3.1.mdx
@@ -5,8 +5,6 @@ order: 9
description: 'This guide covers upgrading a 3.0 Spree store, to a 3.1 store'
---
-# 3.0 to 3.1
-
## Upgrade Rails
For this Spree release, you will need to upgrade your Rails version to at least 4.2.6.
@@ -20,7 +18,7 @@ gem 'rails', '~> 4.2.6'
For best results, use the spree gem in version 3.1:
```ruby
-gem 'spree', '~> 3.1.0.rc1'
+gem 'spree', '~> 3.1'
```
Run `bundle update spree`.
@@ -39,8 +37,8 @@ rake db:migrate
If you are using Spree Gateway and/or Spree Auth Devise you should also upgrade them:
```ruby
-gem 'spree_auth_devise', '~> 3.1.0.rc1'
-gem 'spree_gateway', '~> 3.1.0.rc1'
+gem 'spree_auth_devise', '~> 3.1'
+gem 'spree_gateway', '~> 3.1'
```
For Spree Auth Devise run installer:
@@ -75,9 +73,4 @@ If you were disabling the alert checks you'll now want to remove this preference
## Read the release notes
-For information about changes contained within this release, please read the [3.1.0 Release Notes](http://guides.spreecommerce.org/release_notes/spree_3_1_0.html).
-
-## Verify that everything is OK
-
-Run your test suite, click around in your store and make sure it's performing as normal. Fix any deprecation warnings you see.
-
+For information about changes contained within this release, please read the [3.1.0 Release Notes](https://github.com/spree/spree/releases/tag/v3.1.0).
diff --git a/docs/developer/upgrades/three-dot-one-to-three-dot-two.mdx b/docs/developer/upgrades/3.1-to-3.2.mdx
similarity index 75%
rename from docs/developer/upgrades/three-dot-one-to-three-dot-two.mdx
rename to docs/developer/upgrades/3.1-to-3.2.mdx
index c72a207866..f6f4681347 100644
--- a/docs/developer/upgrades/three-dot-one-to-three-dot-two.mdx
+++ b/docs/developer/upgrades/3.1-to-3.2.mdx
@@ -5,8 +5,6 @@ order: 8
description: 'This guide covers upgrading a 3.1 Spree store, to a 3.2 store.'
---
-# 3.1 to 3.2
-
### Update your Rails version to 5.0
Please follow the [official Rails guide](http://edgeguides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-from-rails-4-2-to-rails-5-0) to upgrade your store.
@@ -40,9 +38,7 @@ gem 'spree_braintree_vzero', github: 'spree-contrib/spree_braintree_vzero'
### Install missing migrations
```bash
-rails spree:install:migrations
-rails spree_auth:install:migrations
-rails spree_gateway:install:migrations
+rake railties:install:migrations
```
### Run migrations
@@ -53,9 +49,4 @@ rails db:migrate
## Read the release notes
-For information about changes contained within this release, please read the [3.2.0 Release Notes](http://guides.spreecommerce.org/release_notes/spree_3_2_0.html).
-
-## Verify that everything is OK
-
-Run your test suite, click around in your store and make sure it's performing as normal. Fix any deprecation warnings you see.
-
+For information about changes contained within this release, please read the [3.2.0 Release Notes](https://github.com/spree/spree/releases/tag/v3.2.0).
diff --git a/docs/developer/upgrades/three-dot-two-to-three-dot-three.mdx b/docs/developer/upgrades/3.2-to-3.3.mdx
similarity index 85%
rename from docs/developer/upgrades/three-dot-two-to-three-dot-three.mdx
rename to docs/developer/upgrades/3.2-to-3.3.mdx
index 4d5b2138b5..33c1a8082b 100644
--- a/docs/developer/upgrades/three-dot-two-to-three-dot-three.mdx
+++ b/docs/developer/upgrades/3.2-to-3.3.mdx
@@ -5,8 +5,6 @@ order: 7
description: 'This guide covers upgrading a 3.2 Spree store, to a 3.3 store.'
---
-# 3.2 to 3.3
-
### Update your Rails version to 5.1
Please follow the [official Rails guide](http://edgeguides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-from-rails-5-0-to-rails-5-1) to upgrade your store.
@@ -40,9 +38,7 @@ gem 'spree_braintree_vzero', github: 'spree-contrib/spree_braintree_vzero'
### Install missing migrations
```bash
-rails spree:install:migrations
-rails spree_auth:install:migrations
-rails spree_gateway:install:migrations
+rake railties:install:migrations
```
### Run migrations
@@ -70,13 +66,13 @@ end
Spree 3.3 comes with paperclip 5.1 support so if you're using Amazon S3 storage you need to change in your Gemfile, from:
```ruby
-gem 'aws-sdk', '< 2'
+gem 'aws-sdk', '< 2.0'
```
to:
```ruby
-gem 'aws-sdk', '>= 2'
+gem 'aws-sdk', '>= 2.0'
```
and run `bundle update aws-sdk`
@@ -91,9 +87,4 @@ If your application.js file includes line `//= require jquery.validate/jquery.va
## Read the release notes
-For information about changes contained within this release, please read the [3.3.0 Release Notes](http://guides.spreecommerce.org/release_notes/spree_3_3_0.html).
-
-## Verify that everything is OK
-
-Run your test suite, click around in your store and make sure it's performing as normal. Fix any deprecation warnings you see.
-
+For information about changes contained within this release, please read the [3.3.0 Release Notes](https://github.com/spree/spree/releases/tag/v3.3.0).
diff --git a/docs/developer/upgrades/three-dot-three-to-three-dot-four.mdx b/docs/developer/upgrades/3.3-to-3.4.mdx
similarity index 66%
rename from docs/developer/upgrades/three-dot-three-to-three-dot-four.mdx
rename to docs/developer/upgrades/3.3-to-3.4.mdx
index a578afd81a..d8afca45d0 100644
--- a/docs/developer/upgrades/three-dot-three-to-three-dot-four.mdx
+++ b/docs/developer/upgrades/3.3-to-3.4.mdx
@@ -5,8 +5,6 @@ order: 6
description: 'This guide covers upgrading a 3.3 Spree store, to a 3.4 store.'
---
-# 3.3 to 3.4
-
### Update Gemfile
```ruby
@@ -20,9 +18,7 @@ gem 'spree_gateway', '~> 3.3'
### Install missing migrations
```bash
-rails spree:install:migrations
-rails spree_auth:install:migrations
-rails spree_gateway:install:migrations
+rake railties:install:migrations
```
### Run migrations
@@ -41,9 +37,6 @@ rails db:migrate_taxon_icons
## Read the release notes
-For information about changes contained within this release, please read the [3.4.0 Release Notes](http://guides.spreecommerce.org/release_notes/spree_3_4_0.html).
-
-## Verify that everything is OK
+For information about changes contained within this release, please read the [3.4.0 Release Notes](https://github.com/spree/spree/releases/tag/v3.4.0).
-Run your test suite, click around in your store and make sure it's performing as normal. Fix any deprecation warnings you see.
diff --git a/docs/developer/upgrades/three-dot-four-to-three-dot-five.mdx b/docs/developer/upgrades/3.4-to-3.5.mdx
similarity index 73%
rename from docs/developer/upgrades/three-dot-four-to-three-dot-five.mdx
rename to docs/developer/upgrades/3.4-to-3.5.mdx
index 087ba71c72..6934c582ed 100644
--- a/docs/developer/upgrades/three-dot-four-to-three-dot-five.mdx
+++ b/docs/developer/upgrades/3.4-to-3.5.mdx
@@ -5,8 +5,6 @@ order: 5
description: 'This guide covers upgrading a 3.4 Spree store, to a 3.5 store.'
---
-# 3.4 to 3.5
-
### Update Gemfile
```ruby
@@ -20,9 +18,7 @@ gem 'spree_gateway', '~> 3.3'
### Install missing migrations
```bash
-rails spree:install:migrations
-rails spree_auth:install:migrations
-rails spree_gateway:install:migrations
+rake railties:install:migrations
```
### Run migrations
@@ -57,9 +53,7 @@ You're good to go!
## Read the release notes
-For information about changes contained within this release, please read the [3.5.0 Release Notes](http://guides.spreecommerce.org/release_notes/spree_3_5_0.html).
+For information about changes contained within this release, please read the [3.5.0 Release Notes](https://github.com/spree/spree/releases/tag/v3.5.0).
-## Verify that everything is OK
-Run your test suite, click around in your store and make sure it's performing as normal. Fix any deprecation warnings you see.
diff --git a/docs/developer/upgrades/three-dot-five-to-three-dot-six.mdx b/docs/developer/upgrades/3.5-to-3.6.mdx
similarity index 72%
rename from docs/developer/upgrades/three-dot-five-to-three-dot-six.mdx
rename to docs/developer/upgrades/3.5-to-3.6.mdx
index 87ca0db5ed..f1e451a274 100644
--- a/docs/developer/upgrades/three-dot-five-to-three-dot-six.mdx
+++ b/docs/developer/upgrades/3.5-to-3.6.mdx
@@ -5,12 +5,10 @@ order: 4
description: 'This guide covers upgrading a 3.5 Spree application, to a 3.6 application.'
---
-# 3.5 to 3.6
-
### Update Gemfile
```ruby
-gem 'spree', '~> 3.6.1'
+gem 'spree', '~> 3.6'
gem 'spree_auth_devise', '~> 3.3'
gem 'spree_gateway', '~> 3.3'
```
@@ -30,9 +28,7 @@ You can still use paperclip for attachment management by setting `SPREE_USE_PAPE
### Install missing migrations
```bash
-rails spree:install:migrations
-rails spree_auth:install:migrations
-rails spree_gateway:install:migrations
+rake railties:install:migrations
```
### Run migrations
@@ -45,9 +41,4 @@ You're good to go!
## Read the release notes
-For information about changes contained within this release, please read the [3.6.0 Release Notes](http://guides.spreecommerce.org/release_notes/spree_3_6_0.html).
-
-## Verify that everything is OK
-
-Run your test suite, click around in your application and make sure it's performing as normal. Fix any deprecation warnings you see.
-
+For information about changes contained within this release, please read the [3.6.0 Release Notes](https://github.com/spree/spree/releases/tag/v3.6.0).
diff --git a/docs/developer/upgrades/three-dot-six-to-three-dot-seven.mdx b/docs/developer/upgrades/3.6-to-3.7.mdx
similarity index 86%
rename from docs/developer/upgrades/three-dot-six-to-three-dot-seven.mdx
rename to docs/developer/upgrades/3.6-to-3.7.mdx
index 24a9b80f3c..48fed88dd2 100644
--- a/docs/developer/upgrades/three-dot-six-to-three-dot-seven.mdx
+++ b/docs/developer/upgrades/3.6-to-3.7.mdx
@@ -5,8 +5,6 @@ order: 3
description: 'This guide covers upgrading a 3.6 Spree application, to version 3.7.'
---
-# 3.6 to 3.7
-
## Update Gemfile
```ruby
@@ -20,10 +18,7 @@ gem 'spree_gateway', '~> 3.4'
## Install missing migrations
```bash
-rails spree:install:migrations
-rails spree_api:install:migrations
-rails spree_auth:install:migrations
-rails spree_gateway:install:migrations
+rake railties:install:migrations
```
## Run migrations
@@ -66,5 +61,4 @@ This will set `currency` in Orders without currency set to `Spree::Config[:defau
## Read the release notes
-For information about changes contained within this release, please read the [3.7.0 Release Notes](https://guides.spreecommerce.org/release_notes/spree_3_7_0.html).
-
+For information about changes contained within this release, please read the [3.7.0 Release Notes](https://github.com/spree/spree/releases/tag/v3.7.0).
diff --git a/docs/developer/upgrades/three-dot-seven-to-four-dot-oh.mdx b/docs/developer/upgrades/3.7-to-4.0.mdx
similarity index 54%
rename from docs/developer/upgrades/three-dot-seven-to-four-dot-oh.mdx
rename to docs/developer/upgrades/3.7-to-4.0.mdx
index 0ccece001c..e59be6603c 100644
--- a/docs/developer/upgrades/three-dot-seven-to-four-dot-oh.mdx
+++ b/docs/developer/upgrades/3.7-to-4.0.mdx
@@ -5,21 +5,18 @@ order: 2
description: This guide covers upgrading a 3.7 Spree application to Spree 4.0.
---
-If you have any questions or suggestions feel free to reach out through [Spree slack channels](http://slack.spreecommerce.org/)
-**If you're on an older version than 3.7 please follow previous upgrade guides and perform those upgrades incrementally**, eg.
+<Note>
+If you're on an older version than 3.7 please follow previous upgrade guides and perform those upgrades incrementally**, eg.
-1. [upgrade 3.2 to 3.3](/developer/upgrades/three-dot-two-to-three-dot-three)
-2. [upgrade 3.3 to 3.4](/developer/upgrades/three-dot-three-to-three-dot-four)
-3. [upgrade 3.4 to 3.5](/developer/upgrades/three-dot-four-to-three-dot-five)
-4. [upgrade 3.5 to 3.6](/developer/upgrades/three-dot-five-to-three-dot-six)
-5. [upgrade 3.6 to 3.7](/developer/upgrades/three-dot-six-to-three-dot-seven)
+1. [upgrade 3.4 to 3.5](3.4-to-3.5)
+2. [upgrade 3.5 to 3.6](3.5-to-3.6)
+3. [upgrade 3.6 to 3.7](3.6-to-3.7)
+</Note>
-This is the safest and recommended method.
+## Update your Ruby version to 2.5
-## Update your Ruby version to 2.5.0 at least
-
-Spree 4.0 requires Ruby 2.5.0 at least so you need to bump the ruby version in your project's `Gemfile` and `.ruby-version` files.
+Spree 4.0 requires Ruby 2.5 o you need to bump the ruby version in your project's `Gemfile` and `.ruby-version` files.
## Migrate from Paperclip to ActiveStorage
@@ -31,103 +28,9 @@ Please remove also any occurrences of `Rails.application.config.use_paperclip` a
Please follow the [official Paperclip to ActiveStorage migration guide](https://github.com/thoughtbot/paperclip/blob/master/MIGRATING).
-## Replace OrderContents with services in your codebase
-
-`OrderContents` was deprecated in Spree 3.7 and removed in 4.0. We've replaced it with [service objects](https://guides.spreecommerce.org/release_notes/3_7_0.html#service-oriented-architecture).
-
-You need to replace any instances of `OrderContents` usage with corresponding services in your codebase.
-
-### `OrderContents#update_cart`
-
-before:
-
-```ruby
-order.contents.update_cart(line_items_attributes)
-```
-
-after:
-
-```ruby
-Spree::Cart::Update.call(order: order, params: line_items_attributes)
-```
-
-### `OrderContents#add`
-
-before:
-
-```ruby
-order.contents.add(variant, quantity, shipment: shipment)
-```
-
-after:
-
-```ruby
-Spree::Cart::AddItem.call(
- order: order,
- variant: variant,
- quantity: quantity,
- options: {
- shipment: @shipment
- }
-)
-```
-
-### `OrderContents#remove`
-
-before:
-
-```ruby
-order.contents.remove(variant, quantity, shipment: shipment)
-```
-
-after:
-
-```ruby
-Spree::Cart::RemoveItem.call(
- order: order,
- variant: variant,
- quantity: quantity,
- options: {
- shipment: shipment
- }
-)
-```
-
-## Replace `add_store_credit_payments` with `Checkout::AddStoreCredit`
-
-Similar to `OrderContents` method `add_store_credit_payments` was replaced with `Checkout::AddStoreCredit` service.
-
-before:
-
-```ruby
-order.add_store_credit_payments
-```
-
-after:
-
-```ruby
-Spree::Checkout::AddStoreCredit.call(order: order)
-```
-
-## Replace `remove_store_credit_payments` with `Checkout::RemoveStoreCredit`
-
-Similar to `OrderContents` method `remove_store_credit_payments` was replaced with `Checkout::RemeoveStoreCredit` service.
-
-before:
-
-```ruby
-order.remove_store_credit_payments
-```
-
-after:
-
-```ruby
-Spree::Checkout::RemoveStoreCredit.call(order: order)
-```
-
## Remove `spree_address_book` extension
-If you're using the [Address Book](https://github.com/spree-contrib/spree_address_book) extension you need to remove it as this feature was merged into [core Spree](https://guides.spreecommerce.org/release_notes/4_0_0.html#address-book-support).
+If you're using the [Address Book](https://github.com/spree-contrib/spree_address_book) extension you need to remove it as this feature was merged into [core Spree](https://github.com/spree/spree/releases/tag/v4.0.0).
1. Remove this line from `Gemfile`
@@ -219,8 +122,8 @@ As we know this is a big portion of work you can still use Bootstrap 3 for your
## Update Gemfile
```ruby
-gem 'spree', '~> 4'
-gem 'spree_auth_devise', '~> 4'
+gem 'spree', '~> 4.0'
+gem 'spree_auth_devise', '~> 4.0'
gem 'spree_gateway', '~> 3.6'
```
@@ -229,10 +132,7 @@ gem 'spree_gateway', '~> 3.6'
## Install missing migrations
```bash
-rails spree:install:migrations
-rails spree_api:install:migrations
-rails spree_auth:install:migrations
-rails spree_gateway:install:migrations
+rake railties:install:migrations
```
## Run migrations
@@ -243,9 +143,4 @@ rails db:migrate
## Read the release notes
-For information about changes contained within this release, please read the [4.0.0 Release Notes](https://guides.spreecommerce.org/release_notes/spree_4_0_0.html).
-
-## More info
-
-If you have any questions or suggestions feel free to reach out through [Spree slack channels](http://slack.spreecommerce.org/)
-
+For information about changes contained within this release, please read the [4.0.0 Release Notes](https://github.com/spree/spree/releases/tag/v4.0.0)
\ No newline at end of file
diff --git a/docs/developer/upgrades/4.0-to-4.1.mdx b/docs/developer/upgrades/4.0-to-4.1.mdx
index 9bbcf36e86..361d514681 100644
--- a/docs/developer/upgrades/4.0-to-4.1.mdx
+++ b/docs/developer/upgrades/4.0-to-4.1.mdx
@@ -5,17 +5,13 @@ order: 1
description: This guide covers upgrading a 4.0 Spree application to Spree 4.1.
---
-If you have any questions or suggestions feel free to reach out through [Spree slack channels](http://slack.spreecommerce.org/)
+<Note>
+If you're on an older version than 4.0 please follow previous upgrade guides and perform those upgrades incrementally**, eg.
-**If you're on an older version than 4.0 please follow previous upgrade guides and perform those upgrades incrementally**, eg.
-
-1. [upgrade 3.3 to 3.4](/developer/upgrades/three-dot-three-to-three-dot-four)
-2. [upgrade 3.4 to 3.5](/developer/upgrades/three-dot-four-to-three-dot-five)
-3. [upgrade 3.5 to 3.6](/developer/upgrades/three-dot-five-to-three-dot-six)
-4. [upgrade 3.6 to 3.7](/developer/upgrades/three-dot-six-to-three-dot-seven)
-5. [upgrade 3.7 to 4.0](/developer/upgrades/three-dot-seven-to-four-dot-oh)
-
-This is the safest and recommended method.
+1. [upgrade 3.5 to 3.6](3.5-to-3.6)
+2. [upgrade 3.6 to 3.7](3.6-to-3.7)
+3. [upgrade 3.7 to 4.0](3.7-to-4.0)
+</Note>
## Update Gemfile
@@ -29,7 +25,7 @@ gem 'spree_gateway', '~> 3.9'
## Install missing migrations
```bash
-rails spree:install:migrations
+rake railties:install:migrations
```
## Run migrations
@@ -110,9 +106,4 @@ If you wish to not move to the new Storefront UI it's still an option. Just proc
## Read the release notes
-For information about changes contained within this release, please read the [4.1.0 Release Notes](https://guides.spreecommerce.org/release_notes/spree_4_1_0.html).
-
-## More info
-
-If you have any questions or suggestions feel free to reach out through [Spree slack channels](http://slack.spreecommerce.org/)
-
+For information about changes contained within this release, please read the [4.1.0 Release Notes](https://github.com/spree/spree/releases/tag/v4.1.0).
diff --git a/docs/developer/upgrades/4.1-to-4.2.mdx b/docs/developer/upgrades/4.1-to-4.2.mdx
index 6f6d3ee977..7df5060f3d 100644
--- a/docs/developer/upgrades/4.1-to-4.2.mdx
+++ b/docs/developer/upgrades/4.1-to-4.2.mdx
@@ -5,14 +5,13 @@ order: 0
description: This guide covers upgrading a 4.1 Spree application to Spree 4.2.
---
-If you have any questions or suggestions feel free to reach out through [Spree slack channels](http://slack.spreecommerce.org/)
-**If you're on an older version than 4.1 please follow previous upgrade guides and perform those upgrades incrementally**, eg.
+<Note>
+If you're on an older version than 4.1 please follow previous upgrade guides and perform those upgrades incrementally**, eg.
-1. [upgrade 3.7 to 4.0](/developer/upgrades/three-dot-seven-to-four-dot-oh)
-2. [upgrade 4.0 to 4.1](/developer/upgrades/four-dot-oh-to-4.1)
-
-This is the safest and recommended method.
+1. [upgrade 3.7 to 4.0](3.7-to-4.0)
+2. [upgrade 4.0 to 4.1](4.0-to-4.1)
+</Note>
## Update Gemfile
@@ -74,8 +73,7 @@ class AddStockLocationToRMA < ActiveRecord::Migration[4.2]
## Install missing migrations
```bash
-rails spree:install:migrations
-rails active_storage:update
+rake railties:install:migrations
```
## Run migrations
@@ -125,5 +123,5 @@ For information about changes contained within this release, please read the [4.
## More info
-If you have any questions or suggestions feel free to reach out through [Spree slack channels](http://slack.spreecommerce.org/)
+
diff --git a/docs/developer/upgrades/4.2-to-4.3.mdx b/docs/developer/upgrades/4.2-to-4.3.mdx
index 28fb89868f..367cac712f 100644
--- a/docs/developer/upgrades/4.2-to-4.3.mdx
+++ b/docs/developer/upgrades/4.2-to-4.3.mdx
@@ -6,15 +6,13 @@ hidden: true
description: This guide covers upgrading a 4.2 Spree application to Spree 4.3.
---
-If you have any questions or suggestions feel free to reach out through [Spree slack channels](http://slack.spreecommerce.org/)
+<Note>
+If you're on an older version than 4.1 please follow previous upgrade guides and perform those upgrades incrementally**, eg.
-**If you're on an older version than 4.1 please follow previous upgrade guides and perform those upgrades incrementally**, eg.
-
-1. [upgrade 3.7 to 4.0](three-dot-seven-to-four-dot-oh)
-2. [upgrade 4.0 to 4.1](four-dot-oh-to-4.1)
+1. [upgrade 3.7 to 4.0](3.7-to-4.0)
+2. [upgrade 4.0 to 4.1](4.0-to-4.1)
3. [upgrade 4.1 to 4.2](4.1-to-4.2)
-
-This is the safest and recommended method.
+</Note>
## Update Gemfile
@@ -82,7 +80,7 @@ bundle update
## Install missing migrations
```bash
-bin/rails spree:install:migrations
+rake railties:install:migrations
```
## Run migrations
@@ -135,7 +133,7 @@ bundle update spree_related_products
## Read the release notes
-For information about changes contained within this release, please read the [CHANGELOG](https://github.com/spree/spree/blob/master/CHANGELOG).
+For information about changes contained within this release, please read the [Release notes](https://github.com/spree/spree/releases/v4.3.0).
## More info
diff --git a/docs/developer/upgrades/4.3-to-4.4.mdx b/docs/developer/upgrades/4.3-to-4.4.mdx
index 67b3bcbefa..9efbdc123b 100644
--- a/docs/developer/upgrades/4.3-to-4.4.mdx
+++ b/docs/developer/upgrades/4.3-to-4.4.mdx
@@ -3,12 +3,10 @@ title: 4.3 to 4.4
description: This guide covers upgrading a 4.3 Spree application to Spree 4.4.
---
-If you have any questions or suggestions feel free to reach out through [Spree slack channels](http://slack.spreecommerce.org/)
-
<Note>
If you're on an older version than 4.3 please follow previous upgrade guides and perform those upgrades incrementally, eg.
-1. [upgrade 4.0 to 4.1](four-dot-oh-to-4.1)
+1. [upgrade 4.0 to 4.1](4.0-to-4.1)
2. [upgrade 4.1 to 4.2](4.1-to-4.2)
3. [upgrade 4.2 to 4.3](4.2-to-4.3)
</Note>
@@ -58,7 +56,7 @@ bin/rails db:migrate
### Update Gemfile
```ruby
-gem 'spree_backend', '>= 4.4.0.rc1'
+gem 'spree_backend', '~> 4.4'
```
### Update gems
@@ -81,7 +79,7 @@ bin/rails javascript:install:esbuild
JavaScript required by the `spree_backend` gem is distributed as [a NPM package](https://www.npmjs.com/package/@spree/dashboard).
-```
+```bash
bin/rails g spree:backend:install
```
@@ -103,13 +101,13 @@ Make sure that `spree_stock_location_stock_items` and `spree_webhooks` queues ar
Spree 4.4 introduces webhook events for most of the Spree resources (Products, Orders, Customers, etc). If you wish to disable this globally you can set the environment variable:
-```
+```bash
DISABLE_SPREE_WEBHOOKS=true
```
If you would like to disable firing webhooks for certain elements of your application you can wrap these methods in a block:
-```
+```ruby
Spree::Webhooks.disable_webhooks do
... run your code here ...
end
@@ -137,7 +135,7 @@ Spree::Dependencies.address_update_service
## Read the release notes
-For information about changes contained within this release, please read the [CHANGELOG](https://github.com/spree/spree/blob/master/CHANGELOG).
+For information about changes contained within this release, please read the [CHANGELOG](https://github.com/spree/spree/releases).
## More info
diff --git a/docs/developer/upgrades/4.4-to-4.5.mdx b/docs/developer/upgrades/4.4-to-4.5.mdx
index dd95fc57e9..eaf8252266 100644
--- a/docs/developer/upgrades/4.4-to-4.5.mdx
+++ b/docs/developer/upgrades/4.4-to-4.5.mdx
@@ -107,4 +107,4 @@ And that's a wrap! :tada:
## Read the release notes
-For information about changes contained within this release, please read the[ Spree 4.5.0 Release Notes](https://github.com/spree/spree/releases/tag/v4.5.0).
+For information about changes contained within this release, please read the [Spree 4.5.0 Release Notes](https://github.com/spree/spree/releases/tag/v4.5.0).
diff --git a/docs/developer/upgrades/4.5-to-4.6.mdx b/docs/developer/upgrades/4.5-to-4.6.mdx
index 9caa59e600..ca20331dea 100644
--- a/docs/developer/upgrades/4.5-to-4.6.mdx
+++ b/docs/developer/upgrades/4.5-to-4.6.mdx
@@ -63,7 +63,7 @@ If you're using raw SQL queries (either in the application code, or running in e
If using [Spree Frontend](https://github.com/spree/spree_rails_frontend), run the following additional commands to get everything set up correctly with the updated gems:
-```
+```bash
bin/rails javascript:install:esbuild
bin/rails turbo:install
bin/rails g spree:frontend:install
diff --git a/docs/developer/upgrades/one-dot-oh-to-one-dot-one.mdx b/docs/developer/upgrades/one-dot-oh-to-one-dot-one.mdx
index f0575f9ec0..a82cead478 100644
--- a/docs/developer/upgrades/one-dot-oh-to-one-dot-one.mdx
+++ b/docs/developer/upgrades/one-dot-oh-to-one-dot-one.mdx
@@ -65,8 +65,5 @@ Spree API no longer provides any asset files, so references to these must be rem
For information about what has changed in this release, please read the [1.1.0 Release Notes](http://guides.spreecommerce.org/release_notes/spree_1_1_0.html).
-## Verify that everything is OK
-Click around in your store and make sure it's performing as normal. Fix any deprecation warnings you see.
-```
diff --git a/docs/developer/upgrades/one-dot-one-to-one-dot-two.mdx b/docs/developer/upgrades/one-dot-one-to-one-dot-two.mdx
index 616d9dd668..658bdf712f 100644
--- a/docs/developer/upgrades/one-dot-one-to-one-dot-two.mdx
+++ b/docs/developer/upgrades/one-dot-one-to-one-dot-two.mdx
@@ -53,8 +53,5 @@ This may copy over additional migrations from spree_auth_devise and run them as
For information about changes contained with this release, please read the [1.2.0 Release Notes](http://guides.spreecommerce.org/release_notes/spree_1_2_0.html).
-## Verify that everything is OK
-Click around in your store and make sure it's performing as normal. Fix any deprecation warnings you see.
-```
diff --git a/docs/developer/upgrades/one-dot-three-to-two-dot-oh.mdx b/docs/developer/upgrades/one-dot-three-to-two-dot-oh.mdx
index 8db6a9ff70..47fe485070 100644
--- a/docs/developer/upgrades/one-dot-three-to-two-dot-oh.mdx
+++ b/docs/developer/upgrades/one-dot-three-to-two-dot-oh.mdx
@@ -62,8 +62,5 @@ these commands:
For information about changes contained with this release, please read the [2.0.0 Release Notes](http://guides.spreecommerce.org/release_notes/spree_2_0_0.html).
-## Verify that everything is OK
-Click around in your store and make sure it's performing as normal. Fix any deprecation warnings you see.
-```
diff --git a/docs/developer/upgrades/one-dot-two-to-one-dot-three.mdx b/docs/developer/upgrades/one-dot-two-to-one-dot-three.mdx
index 4950803398..c73adc191b 100644
--- a/docs/developer/upgrades/one-dot-two-to-one-dot-three.mdx
+++ b/docs/developer/upgrades/one-dot-two-to-one-dot-three.mdx
@@ -84,8 +84,5 @@ Or you can rely on the current currency within views:
For information about changes contained with this release, please read the [1.3.0 Release Notes](http://guides.spreecommerce.org/release_notes/spree_1_3_0.html).
-## Verify that everything is OK
-Click around in your store and make sure it's performing as normal. Fix any deprecation warnings you see.
-```
diff --git a/docs/mint.json b/docs/mint.json
index b556763134..3047f7a9db 100644
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -109,14 +109,6 @@
]
},
- {
- "group": "Contributing",
- "pages": [
- "developer/contributing/quickstart",
- "developer/contributing/creating-an-extension"
- ]
- },
-
{
"group": "Upgrading",
"pages": [
@@ -130,12 +122,32 @@
"developer/upgrades/4.3-to-4.4",
"developer/upgrades/4.2-to-4.3",
"developer/upgrades/4.1-to-4.2",
- "developer/upgrades/4.0-to-4.1"
+ "developer/upgrades/4.0-to-4.1",
+ "developer/upgrades/3.7-to-4.0",
+ "developer/upgrades/3.6-to-3.7",
+ "developer/upgrades/3.5-to-3.6",
+ "developer/upgrades/3.4-to-3.5",
+ "developer/upgrades/3.3-to-3.4",
+ "developer/upgrades/3.2-to-3.3",
+ "developer/upgrades/3.1-to-3.2",
+ "developer/upgrades/3.0-to-3.1",
+ "developer/upgrades/2.3-to-2.4",
+ "developer/upgrades/2.2-to-2.3",
+ "developer/upgrades/2.1-to-2.2",
+ "developer/upgrades/2.0-to-2.1"
]
}
]
},
+ {
+ "group": "Contributing",
+ "pages": [
+ "developer/contributing/quickstart",
+ "developer/contributing/creating-an-extension"
+ ]
+ },
+
{
"group": "API basics",
"pages": [