upgrade-rails

Upgrade Rails

When to use

• The app runs Rails 8.0 or older (8.0 security support ends 7 Nov 2026; 7.2 and older are EOL; see legacy/rails-legacy).
• A security fix exists only in a supported release (8.1).

For a patch release within the same minor, update the gem and run Verify.

Before you start

• Read Rails, Ruby and gems with their own Rails ranges (Devise, Sidekiq, Pundit/CanCanCan, Paperclip/Shrine, Ransack, RSpec Rails, Webpacker/jsbundling) from Gemfile.lock.
• Ruby per target: Rails 8.0 and 8.1 need Ruby 3.2+ (3.2 is EOL; aim for 3.4 or 4.0). Upgrade Ruby as its own step, before or after a Rails hop, never in the same change.
• Working tree clean; new branch (chore/rails-7.2); test suite green (record failures); CI can run a second Gemfile.
• Ask the user:
  • target (default 8.1);
  • whether to stop after each minor for review;
  • whether installing next_rails and gem updates is approved (core/supply-chain).
• Plan the hops: every minor in order (6.1 → 7.0 → 7.1 → 7.2 → 8.0 → 8.1). From 5.x or older, go through each minor as well.

Steps

1. Baseline: patch the current minor to its last release, then save deprecation warnings:

   bundle exec rspec                         # or: bin/rails test
   DEPRECATION_TRACKER=save bundle exec rspec
   

2. Dual boot: add next_rails (1.7) to the development and test groups, run next_rails --init (adds the next? helper and Gemfile.next), and set the next version conditionally:

   if next?
     gem "rails", "~> 7.2.0"
   else
     gem "rails", "~> 7.1.0"
   end
   

   Then next bundle install and add a CI job with BUNDLE_GEMFILE=Gemfile.next.

3. Compatibility: bundle_report compatibility --rails-version=7.2 and bundle_report outdated; upgrade blocking gems in the current Gemfile first, where they support both versions.

4. Fix until green on both: run the suite with next bundle exec rspec; fix deprecations and breaking changes from the upgrade guide for that version; use next? branches only as temporary shims.

5. Switch: make the next version the default, run bin/rails app:update, review every config diff (don't accept overwrites blindly), and commit the generated new_framework_defaults_X_Y.rb.

6. Framework defaults: enable the new defaults one at a time (with a deploy between risky ones like cookie or cache formats), then set config.load_defaults X.Y and delete the initializer.

7. Release-specific checks (examples): 7.0 Zeitwerk-only autoloading and encrypted cookies changes; 7.1 config.autoload_lib, ActiveRecord encryption defaults; 7.2 Ruby 3.1+, YJIT on by default, browser-version guard and dev container generator; 8.0 Solid Queue/Cache/Cable defaults (opt-in for existing apps), Propshaft for new apps, Kamal 2; 8.1 the guide's removals.

8. After each hop: Verify, show the diff and results, wait for approval. Commit only when asked (git-commit skill). Remove next_rails shims at the end.