Building a Ruby Project
What This Guide Covers
Choosing Ruby versions/implementations to test against
Ruby workers on travis-ci.org use RVM to provide many Ruby versions/implementations your projects can be tested against.
To specify them, use
rvm: key in your
.travis.yml file, for example:
language: ruby rvm: - 1.9.3 - jruby-18mode # JRuby in 1.8 mode - jruby-19mode # JRuby in 1.9 mode - rbx-2.1.1 - 1.8.7
A more extensive example:
language: ruby rvm: - 1.9.3 - 1.9.2 - jruby-18mode - jruby-19mode - rbx-2.1.1 - ruby-head - jruby-head - 1.8.7 - ree
As time goes, new releases come out and we upgrade both RVM and Rubies, aliases like
jruby will float and point to different exact versions, patch levels and so on. For full up-to-date list of provided Rubies, see our CI environment guide.
Rubinius releases frequent updates which can be found on the Rubinius downloads page. Binaries for Travis should be available for every release from 2.1.1 onwards. To test against a release of Rubinius, add
rbx-X.Y.Z to your
.travis.yml, where X.Y.Z specifies a Rubinius release.
JRuby: C extensions support is disabled
Please note that C extensions are disabled for JRuby on travis-ci.org. The reason for doing so is to bring it to developers attention that their project may have dependencies that should not be used on JRuby in production. Using C extensions on JRuby is technically possible but is not a good idea performance and stability-wise and we believe continuous integration services like Travis should highlight it.
So if you want to run CI against JRuby, please check that your Gemfile takes JRuby into account. Most of popular C extensions these days also have Java implementations (json gem, nokogiri, eventmachine, bson gem) or Java alternatives (like JDBC-based drivers for MySQL, PostgreSQL and so on).
Default Test Script
Travis will use Bundler to install your project's dependencies and run
rake by default to execute your tests. Please note that you need to add rake to your Gemfile (adding it to just
:test group should be sufficient).
Travis uses Bundler
Travis uses Bundler to install your project's dependencies. It is possible to override this behavior and there are project that use RVM gemset import feature but the majority of Ruby projects hosted on Travis use Bundler.
Exclude non-essential gems like ruby-debug from your Gemfile
We ask Ruby project maintainers to exclude ruby-debug from being installed on travis-ci.org. Consider the following: a project that installs ruby-debug, tests against 6 Ruby versions/implementations and does 3 pushes a day. Given that linecache, one of the ruby-debug dependencies, takes 2 minutes to install in our CI VMs, this results in
3 * 6 * 2 = 36 minutes of time per day per project
And, of course, nobody will really use ruby-debug in CI environments. To exclude ruby-debug and other gems that are non-essential for your test suite, move them to a separate gem group (for example, :debug) and exclude it using bundler_args in your .travis.yml like amqp gem does.
Time is better spent testing your project against more Ruby versions/implementations and more versions of libraries you depend on than compiling linecache over and over.
Custom Bundler arguments and Gemfile locations
You can specify a custom Gemfile name:
Unless specified, the worker will look for a file named "Gemfile" in the root of your project.
You can also set extra arguments to be passed to
You can also define a script to be run before 'bundle install':
For example, to install and use the pre-release version of bundler:
before_install: gem install bundler --pre
Testing against multiple versions of dependencies (Ruby on Rails, EventMachine, etc)
Many projects need to be tested against multiple versions of Rack, EventMachine, HAML, Sinatra, Ruby on Rails, you name it. It is easy with Travis CI. What you have to do is this:
- Create a directory in your project's repository root where you will keep gemfiles (./gemfiles is a commonly used name)
- Add one or more gemfiles to it
- Instruct Travis CI to use those gemfiles using the gemfile option in your .travis.yml
For example, amqp gem is tested against EventMachine 0.12.x and 1.0 pre-releases:
gemfile: - Gemfile - gemfiles/eventmachine-pre
Thoughtbot's Paperclip is tested against multiple ActiveRecord versions:
gemfile: - gemfiles/rails2.gemfile - gemfiles/rails3.gemfile - gemfiles/rails3_1.gemfile
An alternative to this is to use environment variables and make your test runner use them. For example, Sinatra is tested against multiple Tilt and Rack versions:
env: - "rack=1.3.4" - "rack=master" - "tilt=1.3.3" - "tilt=master"
ChefSpec is tested against multiple Opscode Chef versions:
env: - CHEF_VERSION=0.9.18 - CHEF_VERSION=0.10.2 - CHEF_VERSION=0.10.4
Same technique is often applied to test against multiple databases, templating engines, [hosted] service providers and so on.
Testing against multiple JDKs (JRuby)
It is possible to test projects against multiple JDKs, namely
- OpenJDK 7
- Oracle JDK 7
- OpenJDK 6
To do so, use the
:jdk key in your
.travis.yml, for example:
jdk: - oraclejdk7 - openjdk7
or all 3:
jdk: - openjdk7 - oraclejdk7 - openjdk6
Each JDK you test against will create permutations with all other configurations, so to avoid running tests for, say, CRuby 1.9.3 multiple times you need to add some matrix excludes (described in our general Build Configuration guide):
language: ruby rvm: - 1.9.2 - jruby-18mode - jruby-19mode - jruby-head jdk: - openjdk6 - openjdk7 - oraclejdk7 matrix: exclude: - rvm: 1.9.2 jdk: openjdk6 - rvm: 1.9.2 jdk: openjdk7 - rvm: 1.9.2 jdk: oraclejdk7
For example, see travis-support.
travis-ci.org provides exactly the same versions of rubygems RVM and various Ruby implementations/versions ship with. If REE 2011.12 ships with version
1.8.9, it will be
1.8.9 on travis-ci.org. However, if your project or one of its dependencies needs a more recent version of rubygems, you can upgrade them with
before_install: - gem update --system - gem --version