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.

[Skip CI] Docs - added missing upgrade guides (4.9->4.10, 4.10->5.0 WIP)

Damian Legawiec51bb7e2a9193
diff --git a/docs/developer/upgrades/4.1-to-4.2.mdx b/docs/developer/upgrades/4.1-to-4.2.mdx
index 52c5bce603..3f02682ccd 100644
--- a/docs/developer/upgrades/4.1-to-4.2.mdx
+++ b/docs/developer/upgrades/4.1-to-4.2.mdx
@@ -69,7 +69,7 @@ class AddStockLocationToRMA < ActiveRecord::Migration[4.2]
## Install missing migrations
```bash
-bin/rake railties:install:migrations
+bin/rake spree:install:migrations
```
## Run migrations
diff --git a/docs/developer/upgrades/4.10-to-5.0.mdx b/docs/developer/upgrades/4.10-to-5.0.mdx
new file mode 100644
index 0000000000..242a1ff461
--- /dev/null
+++ b/docs/developer/upgrades/4.10-to-5.0.mdx
@@ -0,0 +1,84 @@
+---
+title: Upgrading to Spree 5.0
+description: This guide covers upgrading a Spree 4.10 application to Spree 5.0.
+---
+
+<Info>
+ Before proceeding to upgrade, please ensure you're at [Spree 4.10](/developer/upgrades/4.9-to-4.10)
+</Info>
+
+<Warning>
+ This guide is a work in progress. If you find any issues, please [report them](https://github.com/spree/spree/issues). If you want to contribute to this guide, please click "Suggest edits" at the bottom of this page. Thank you!
+</Warning>
+
+Spree 5.0 is a major upgrade that introduces many breaking changes. The major changes are:
+
+- Dropped support for Rails < 7.2
+- Dropped support for Spree Auth Devise gem (now using Devise gem directly via generator)
+- Completely new modern mobile-friendly Storefront (old customizations won't work)
+- Completely new Admin Dashboard (old customizations won't work)
+- Completely new native Stripe extension
+
+## Prerequisites
+
+Before upgrading, please ensure you have the following prerequisites:
+
+- Ruby 3.2 or later
+- Rails 7.2 - [Upgrade guide for Rails 7.2](https://guides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-from-rails-7-1-to-rails-7-2)
+
+
+## Upgrade steps
+
+<AccordionGroup>
+ <Accordion title="1. Remove old frontend/backend Spree gems">
+
+ ```bash
+ bundle remove spree_auth_devise spree_backend spree_frontend
+ ```
+ <Warning>
+ Remove any code referencing `Spree::Backend`, `Spree::Fronted` or `Spree::Auth` from your application, especially from `config/initializers/spree.rb`.
+ </Warning>
+ </Accordion>
+
+ <Accordion title="2. Update main Spree gem">
+
+ ```bash
+ bundle update spree
+ ```
+ </Accordion>
+
+ <Accordion title="2. Install and run missing migrations">
+
+ ```bash
+ bin/rake spree:install:migrations && bin/rails db:migrate
+ ```
+ </Accordion>
+
+ <Accordion title="3. Add new Spree gems">
+
+ ```bash
+ bundle add spree_storefront spree_admin spree_stripe
+ ```
+
+ And run the following generators:
+
+ ```bash
+ bin/rails g spree:storefront:install
+ bin/rails g spree:admin:install
+ bin/rails g spree_stripe:install
+ ```
+ </Accordion>
+
+ <Accordion title="4. Run the authentication generator (Optional)">
+
+ ```bash
+ bin/rails g spree:authentication:devise
+ ```
+
+ Refer to [Customizing Spree Authentication](/developer/customization/authentication) for more information.
+ </Accordion>
+</AccordionGroup>
+
+## Read the release notes
+
+For information about changes contained within this release, please read the [Spree 5.0 Release Notes.](https://github.com/orgs/spree/discussions/12604)
diff --git a/docs/developer/upgrades/4.3-to-4.4.mdx b/docs/developer/upgrades/4.3-to-4.4.mdx
index 8387c5f636..d363a05315 100644
--- a/docs/developer/upgrades/4.3-to-4.4.mdx
+++ b/docs/developer/upgrades/4.3-to-4.4.mdx
@@ -48,7 +48,7 @@ bundle update
## Install missing migrations
```bash
-bin/rake railties:install:migrations
+bin/rake spree:install:migrations
```
## Run migrations
diff --git a/docs/developer/upgrades/4.4-to-4.5.mdx b/docs/developer/upgrades/4.4-to-4.5.mdx
index 6336169dbb..bef1d91e1c 100644
--- a/docs/developer/upgrades/4.4-to-4.5.mdx
+++ b/docs/developer/upgrades/4.4-to-4.5.mdx
@@ -80,7 +80,7 @@ bundle add spree_api_v1
## Install missing migrations
```bash
-bin/rake railties:install:migrations
+bin/rake spree:install:migrations
```
## Run migrations
diff --git a/docs/developer/upgrades/4.5-to-4.6.mdx b/docs/developer/upgrades/4.5-to-4.6.mdx
index e6adc29505..2fa196ee8d 100644
--- a/docs/developer/upgrades/4.5-to-4.6.mdx
+++ b/docs/developer/upgrades/4.5-to-4.6.mdx
@@ -41,7 +41,7 @@ bundle remove spree_globalize
## Install missing migrations
```bash
-bin/rake railties:install:migrations
+bin/rake spree:install:migrations
```
## Run migrations
diff --git a/docs/developer/upgrades/4.6-to-4.7.mdx b/docs/developer/upgrades/4.6-to-4.7.mdx
index e50b9198ff..1402f59006 100644
--- a/docs/developer/upgrades/4.6-to-4.7.mdx
+++ b/docs/developer/upgrades/4.6-to-4.7.mdx
@@ -27,7 +27,7 @@ If you're on an older version than 4.6 please follow previous upgrade guides and
<Accordion title="2. Install and run missing migrations">
```bash
- bin/rake railties:install:migrations && bin/rails db:migrate
+ bin/rake spree:install:migrations && bin/rails db:migrate
```
</Accordion>
diff --git a/docs/developer/upgrades/4.8-to-4.9.mdx b/docs/developer/upgrades/4.8-to-4.9.mdx
index 4db52bb379..b101221168 100644
--- a/docs/developer/upgrades/4.8-to-4.9.mdx
+++ b/docs/developer/upgrades/4.8-to-4.9.mdx
@@ -4,7 +4,7 @@ description: This guide covers upgrading a Spree 4.8 application to Spree 4.9.
---
<Info>
- Before proceeding to upgrade, please ensure you're at Spree 4.8
+ Before proceeding to upgrade, please ensure you're at [Spree 4.8](/developer/upgrades/4.x-to-4.8)
</Info>
<AccordionGroup>
@@ -18,7 +18,7 @@ description: This guide covers upgrading a Spree 4.8 application to Spree 4.9.
<Accordion title="2. Install and run missing migrations">
```bash
- bin/rake railties:install:migrations && bin/rails db:migrate
+ bin/rake spree:install:migrations && bin/rails db:migrate
```
</Accordion>
</AccordionGroup>
diff --git a/docs/developer/upgrades/4.9-to-4.10.mdx b/docs/developer/upgrades/4.9-to-4.10.mdx
new file mode 100644
index 0000000000..8b2b78abd0
--- /dev/null
+++ b/docs/developer/upgrades/4.9-to-4.10.mdx
@@ -0,0 +1,28 @@
+---
+title: Upgrading to Spree 4.10
+description: This guide covers upgrading a Spree 4.9 application to Spree 4.10.
+---
+
+<Info>
+ Before proceeding to upgrade, please ensure you're at [Spree 4.9](/developer/upgrades/4.8-to-4.9)
+</Info>
+
+<AccordionGroup>
+ <Accordion title="1. Update gems">
+
+ ```bash
+ bundle update
+ ```
+ </Accordion>
+
+ <Accordion title="2. Install and run missing migrations">
+
+ ```bash
+ bin/rake spree:install:migrations && bin/rails db:migrate
+ ```
+ </Accordion>
+</AccordionGroup>
+
+## Read the release notes
+
+For information about changes contained within this release, please read the [Spree 4.10.0 Release Notes.](https://github.com/orgs/spree/discussions/12154)
diff --git a/docs/developer/upgrades/4.x-to-4.8.mdx b/docs/developer/upgrades/4.x-to-4.8.mdx
index 1b670912b4..294c06b5e6 100644
--- a/docs/developer/upgrades/4.x-to-4.8.mdx
+++ b/docs/developer/upgrades/4.x-to-4.8.mdx
@@ -18,7 +18,7 @@ description: This guide covers upgrading a Spree 4 application to Spree 4.8.
<Accordion title="2. Install and run missing migrations">
```bash
- bin/rake railties:install:migrations && bin/rails db:migrate
+ bin/rake spree:install:migrations && bin/rails db:migrate
```
</Accordion>
diff --git a/docs/docs.json b/docs/docs.json
index 50b9f81165..a8a7388561 100644
--- a/docs/docs.json
+++ b/docs/docs.json
@@ -86,6 +86,8 @@
{
"group": "Upgrade Guides",
"pages": [
+ "developer/upgrades/4.10-to-5.0",
+ "developer/upgrades/4.9-to-4.10",
"developer/upgrades/4.8-to-4.9",
"developer/upgrades/4.x-to-4.8",
"developer/upgrades/4.6-to-4.7",