From cb5506565ca591e3c979350c38021e8b7ea03add Mon Sep 17 00:00:00 2001 From: Jan Provaznik <jprovaznik@gitlab.com> Date: Wed, 7 Nov 2018 10:56:43 +0100 Subject: [PATCH] Add rails5 doc --- doc/development/README.md | 1 + doc/development/switching_to_rails5.md | 15 +++++++++++++++ 2 files changed, 16 insertions(+) create mode 100644 doc/development/switching_to_rails5.md diff --git a/doc/development/README.md b/doc/development/README.md index 14dfe8eb1f32d..0080c34c05695 100644 --- a/doc/development/README.md +++ b/doc/development/README.md @@ -51,6 +51,7 @@ description: 'Learn how to contribute to GitLab.' - [Prometheus metrics](prometheus_metrics.md) - [Guidelines for reusing abstractions](reusing_abstractions.md) - [DeclarativePolicy framework](policies.md) +- [Switching to Rails 5](switching_to_rails5.md) ## Performance guides diff --git a/doc/development/switching_to_rails5.md b/doc/development/switching_to_rails5.md new file mode 100644 index 0000000000000..6b08ff832248d --- /dev/null +++ b/doc/development/switching_to_rails5.md @@ -0,0 +1,15 @@ +# 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. + +### 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. + +### 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. + +### 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. + +### 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 ...` -- GitLab