[RF-DOCS ] Update Upgrading Rails Guide [ci-skip]#4
Conversation
Ridhwana
left a comment
There was a problem hiding this comment.
NOTE: I've reviewed up until line ~140-ish, will continue reviewing
| Before attempting to upgrade an existing application, you should be sure you | ||
| have a good reason to upgrade. You need to balance several factors: the need for | ||
| new features, gem compatibility, the increasing difficulty of finding support | ||
| for old code and your available time and skills, to name a few. |
There was a problem hiding this comment.
(non-blocking, suggestion): I felt that this reads a bit awkward, and I took a stab at rephrasing.
| Before attempting to upgrade an existing application, you should be sure you | |
| have a good reason to upgrade. You need to balance several factors: the need for | |
| new features, gem compatibility, the increasing difficulty of finding support | |
| for old code and your available time and skills, to name a few. | |
| Before upgrading an existing application, make sure you have a clear reason for | |
| doing so. Weigh factors such as the need for new features, gem compatibility, | |
| the decreasing availability of support for older code, and the time and skills | |
| you have available. |
There was a problem hiding this comment.
I think this less defeatist rephrasing is good improvement.
Upgrades of recent version should be much easier than 3.2 to 4.0, for example.
And while I think it is good to warn about attempting to upgrade, I think keeping up-to-date with the latest release is much more encouraged these days (with companies running on main) compared to 2011, when this guide was first written.
I think it would be a good idea to have a paragraph before this that recommends/encourages upgrading.
Maybe something like:
Newer Rails versions introduce new features and performance improvements.
Keeping your Rails application up to date with maintained versions makes sure your application keeps getting security fixes.
There was a problem hiding this comment.
Great, thanks both! I put the recommendation after the intro paragraph instead so we end on a positive :) as follows:
Upgrading an application can be a difficult process, so make sure you have a clear reason for doing so. Weigh up factors such as the need for new features, gem compatibility, the decreasing availability of support for older code and the time and skills you have available.
Newer Rails versions introduce new features and improvements, so keeping your application up to date with maintained versions will ensure it receives these benefits.
| In Rails 7.2, all tests will respect the `queue_adapter` config if provided. | ||
| This may cause test errors, if you had set the `queue_adapter` config to | ||
| something other than `:test`, but written tests in a way that was dependent on | ||
| the `TestAdapter`. | ||
|
|
||
| If no config is provided, the `TestAdapter` will continue to be used. | ||
|
|
||
| Upgrading from Rails 7.0 to Rails 7.1 |
There was a problem hiding this comment.
@Ridhwana thanks for this one! I'm having a look but it occurred to me it's quite nice to see a sort of one-sentence summary of the changes in that release when the reader looks down the list of subheadings. If we shorten them e.g. 'all tests now respect the active_job.queue_adapter config' -> 'tests and active_job.queue_adapter' I think we lose information about the nature of the change.
Is the above what you had in mind or have you got a better solution? Also, which don't make sense to you? I can have a go at rewording some specific sub headings if you think they are badly worded.
Ridhwana
left a comment
There was a problem hiding this comment.
I've reviewed the main file upgrading_ruby_on_rails.md. I need to review the other upgrade files.
Sorry for the delay on this PR, this one is a big one 😅
|
Hi @OughtPuts - not sure if you've already seen this, but wanted to leave this community feedback/request for the upgrade guides for you here https://youtu.be/R9_2YUUrQ-g?t=1412 (This is from a RailsConf 2025 talk). |
| Before attempting to upgrade an existing application, you should be sure you | ||
| have a good reason to upgrade. You need to balance several factors: the need for | ||
| new features, gem compatibility, the increasing difficulty of finding support | ||
| for old code and your available time and skills, to name a few. |
There was a problem hiding this comment.
I think this less defeatist rephrasing is good improvement.
Upgrades of recent version should be much easier than 3.2 to 4.0, for example.
And while I think it is good to warn about attempting to upgrade, I think keeping up-to-date with the latest release is much more encouraged these days (with companies running on main) compared to 2011, when this guide was first written.
I think it would be a good idea to have a paragraph before this that recommends/encourages upgrading.
Maybe something like:
Newer Rails versions introduce new features and performance improvements.
Keeping your Rails application up to date with maintained versions makes sure your application keeps getting security fixes.
f5764ac to
83a8d81
Compare
022ce58 to
fe728d0
Compare
fe728d0 to
77ac07d
Compare
7aeb79e to
c012d0b
Compare
c012d0b to
b484eac
Compare

Motivation / Background
This PR has been created to update the Upgrading Rails Guide as part of the Rails Documentation project.
Detail
The following changes have been made:
Additional information
Checklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]