TeamCity
 
7.0
You are viewing the documentation for an earlier version of TeamCity.
  1. TeamCity Documentation
  2. Administrator's Guide
  3. Managing Projects and Build Configurations
  4. Creating and Editing Build Configurations
  5. Configuring Build Steps
  6. Adding Build Features
  7. Ruby Environment Configurator

Ruby Environment Configurator

Last modified: 20 April 2023

Ruby environment configurator build feature passes Ruby interpreter to all build steps. The build feature adds selected Ruby interpreter and gems bin directories to system PATH environment variable and configures other necessary environment variables in case of RVM interpreter. E.g. in Command Line build runner you will be able to directly use such commands as ruby, rake, gem, bundle, etc. Thus if you want to install gems before launching Rake build runner you need to add Command Line build step which launches custom script like:

gem install rake --no-ri --no-rdoc gem install bundler --no-ri --no-rdoc

Ruby Environment Configurator Settings



Option

Description

Ruby interpreter path

Path to Ruby interpreter. If not specified the interpreter will be searched in the PATH. In this field you can use values of environment and system variables. For example:

%env.I_AM_DEFINED_IN_BUILDAGENT_CONFIGURATION%

RVM interpreter

Specify here the RVM interpreter name and optionally a gemset configured on a build agent. Note, that interpreter name cannot be empty. If gemset isn't specified the default one will be used.

tip

This option can be used if you don't want use .rvmrc settings, for instance to run tests on different ruby interpreters instead of hardcoded in .rvmrc file.

RVM with .rvmrc file

Since TeamCity 7.1 Specify here the path to a .rvmrc file which should be relative to the checkout directory. If the file is specified, TeamCity will fetch environment variables using rvm-shell and will pass it to all build steps.

Fail build if Ruby interpreter wasn't found

Check the option to fail build if Ruby environment configurator cannot pass Ruby interpreter to step execution environment because the interpreter wasn't found on agent.