Skip to content

Commit 10deaa8

Browse files
committed
Fix up upgrading guide
1 parent dc678c2 commit 10deaa8

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/Upgrading.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ This file documents important changes needed to upgrade your app's Shopify App v
88

99
[Unreleased](#unreleased)
1010

11+
[Upgrading to `v23.0.0`](#upgrading-to-v2300)
12+
1113
[Upgrading to `v22.2.0`](#upgrading-to-v2220)
1214

1315
[Upgrading to `v22.0.0`](#upgrading-to-v2200)
@@ -54,14 +56,14 @@ Additionally, ActiveJob classes have been moved from `lib/shopify_app/jobs/` to
5456

5557
##### Why this change was made
5658

57-
Rails 7.1+ improved autoloading behavior (via Zeitwerk) now properly handles jobs in the `app/jobs/` directory, loading them lazily when needed rather than eagerly during initialization.
59+
Rails 7.1+'s improved autoloading behavior (via Zeitwerk) properly handles jobs in the `app/jobs/` directory, loading them lazily when needed rather than eagerly during initialization.
5860

5961
##### Migration steps
6062

6163
**For most apps**: No changes needed. The jobs are internal to the gem and will be autoloaded correctly by Rails.
6264

6365
**If your app has custom ActiveJob serializers that reference these jobs**:
64-
1. Ensure you're on Rails 7.1+ before upgrading. [Rails 7.1 Upgrade Guide](https://guides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-from-rails-7-0-to-rails-7-1))
66+
1. Ensure you're on Rails 7.1+ before upgrading. [Rails 7.1 Upgrade Guide](https://guides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-from-rails-7-0-to-rails-7-1)
6567
2. Coordinate deployment timing with apps that have custom serializers
6668
3. Custom serializers will now register before jobs are loaded (correct timing)
6769

@@ -76,8 +78,7 @@ require 'shopify_app/jobs/webhooks_manager_job'
7678

7779
##### Additional dependency changes
7880

79-
- **SQLite**: Development dependency updated from `~> 1.4` to `2.x`
80-
- **Ruby 3.4+**: New development dependencies added: `csv`, `mutex_m` (removed from Ruby 3.4 stdlib)
81+
- **sprockets-rails**: Now a required runtime dependency. Most Rails apps already include this, but if your app uses an alternative asset pipeline (e.g., Propshaft), you may need to add `sprockets-rails` to your Gemfile.
8182

8283
#### (v23.0.0) - Deprecated methods in CallbackController
8384
The following methods from `ShopifyApp::CallbackController` have been deprecated in `v23.0.0`

0 commit comments

Comments
 (0)