diff options
| author | Jon Moss <maclover7@users.noreply.github.com> | 2016-02-11 18:10:22 -0500 |
|---|---|---|
| committer | Jon Moss <maclover7@users.noreply.github.com> | 2016-02-11 18:10:22 -0500 |
| commit | 448276651c7560e02ad5f89816d777fe20ef9f04 (patch) | |
| tree | e7c318283682e723f0b403d9aa353ed68094c0b0 | |
| parent | 887d34c7f6621770a8d17523825d4cc65577acab (diff) | |
| parent | de51b0e70728396c5adffde39ebb55c10cc61204 (diff) | |
| download | rails-448276651c7560e02ad5f89816d777fe20ef9f04.tar.gz rails-448276651c7560e02ad5f89816d777fe20ef9f04.tar.bz2 rails-448276651c7560e02ad5f89816d777fe20ef9f04.zip | |
Merge pull request #23618 from hashbangnz/document-upgrade-process
Document the upgrade process
| -rw-r--r-- | guides/source/upgrading_ruby_on_rails.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/guides/source/upgrading_ruby_on_rails.md b/guides/source/upgrading_ruby_on_rails.md index e631445492..2998e66272 100644 --- a/guides/source/upgrading_ruby_on_rails.md +++ b/guides/source/upgrading_ruby_on_rails.md @@ -16,6 +16,21 @@ Before attempting to upgrade an existing application, you should be sure you hav The best way to be sure that your application still works after upgrading is to have good test coverage before you start the process. If you don't have automated tests that exercise the bulk of your application, you'll need to spend time manually exercising all the parts that have changed. In the case of a Rails upgrade, that will mean every single piece of functionality in the application. Do yourself a favor and make sure your test coverage is good _before_ you start an upgrade. +### The Upgrade Process + +When changing Rails versions, it's best to move slowly, one minor version at a time, in order to make good use of the deprecation warnings. Rails version numbers are in the form Major.Minor.Patch. Major and Minor versions are allowed to make changes to the public API, so this may cause errors in your application. Patch versions only include bug fixes, and don't change any public API. + +The process should go as follows: + +1. Write tests and make sure they pass +1. Move to the latest patch version after your current version +1. Fix tests and deprecated features +1. Move to the latest patch version of the next minor version + +Repeat this process until you reach your target Rails version. Each time you move versions, you will need to change the Rails version number in the Gemfile (and possibly other gem versions) and run `bundle update`. Then run the Update rake task mentioned below to update configuration files, then run your tests. + +You can find a list of all released Rails versions [here](https://rubygems.org/gems/rails/versions). + ### Ruby Versions Rails generally stays close to the latest released Ruby version when it's released: |