summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJan Provaznik <jprovaznik@gitlab.com>2018-11-09 08:28:26 +0100
committerJan Provaznik <jprovaznik@gitlab.com>2018-11-14 12:41:16 +0100
commit955bdcb5d49c22bbc24ecf987fea108a6e67b5af (patch)
treedd5fbd2eff85597a3802113a8faa33965a384cff
parent134edbd7c2b255369461c93f90c5b702f67a75ab (diff)
downloadgitlab-ce-955bdcb5d49c22bbc24ecf987fea108a6e67b5af.tar.gz
Addressed documentation comments
-rw-r--r--doc/development/switching_to_rails5.md30
1 files changed, 21 insertions, 9 deletions
diff --git a/doc/development/switching_to_rails5.md b/doc/development/switching_to_rails5.md
index 6b08ff83224..c9a4ce1a1d1 100644
--- a/doc/development/switching_to_rails5.md
+++ b/doc/development/switching_to_rails5.md
@@ -1,15 +1,27 @@
# Switching to Rails 5
-GitLab has switched recently to Rails 5. This is a big change (especially for backend development) and it introduces couple of temporary inconveniences.
+GitLab switched recently to Rails 5. This is a big change (especially for backend development) and it introduces couple of temporary inconveniences.
-### Q: Hey, after the switch this feature is broken. How is it possible?
-A: Many fixes and tweaks were done to make our codebase compatible with Rails 5, but it's possible that not all issues were found. If you find an bug, please create an issue and assign it ~rails5 label.
+## After the switch, I found a broken feature. What do I do?
-### Q: It takes much longer time to run CI on my merge requests, why?
-A: If we would find a major issue after switching to Rails 5 and we wouldn't be able to fix it, we would have to switch back to Rails 4. To make sure that no Rails 4 incompatible changes are introduced until we are sure that we can stick with Rails 5, we will run CI both with Rails 4 and 5 (this means that CI may take twice more time to finish). This is only a temporary policy and running jobs on Rails 4 will be removed in a couple of weeks.
+Many fixes and tweaks were done to make our codebase compatible with Rails 5, but it's possible that not all issues were found. If you find an bug, please create an issue and assign it the ~rails5 label.
-### Q: Can I skip running Rails 4 tests?
-A: If you are sure that your merge request doesn't introduce any incompatibility, you can just include 'norails4' in your branch name and Rails 4 tests will be skipped.
+## It takes much longer to run CI pipelines that build GitLab. Why?
-### Q: CI is failing on my test with Rails 4, how can I debug it?
-A: You can run specs locally with Rails 4 with: `BUNDLE_GEMFILE=Gemfile.rails4 RAILS5=0 bundle exec rspec ...`
+We are temporarily running CI pipelines with Rails 4 and 5 so that we ensure we remain compatible with Rails 4 in case we must revert back to Rails 4 from Rails 5 (this can double the duration of CI pipelines).
+
+We might revert back to Rails 4 if we found a major issue we were unable to quickly fix.
+
+Once we are sure we can stay with Rails 5, we will stop running CI pipelines with Rails 4.
+
+## Can I skip running Rails 4 tests?
+
+If you are sure that your merge request doesn't introduce any incompatibility, you can just include `norails4` anywhere in your branch name and Rails 4 tests will be skipped.
+
+## CI is failing on my test with Rails 4. How can I debug it?
+
+You can run specs locally with Rails 4 using the following command:
+
+```sh
+BUNDLE_GEMFILE=Gemfile.rails4 RAILS5=0 bundle exec rspec ...
+```