TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildFeatures/RubyEnvConfigurator

RubyEnvConfigurator

open class RubyEnvConfigurator : BuildFeature

fun BuildFeatures.rubyEnvConfigurator(init: RubyEnvConfigurator.() -> Unit): RubyEnvConfigurator

A Ruby Environment Configurator build feature passes Ruby interpreter to all build steps.

Example. Adds a Ruby Environment Configurator build feature with specified Ruby interpreter path with a reference to a configuration parameter.

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        rubyEnvConfigurator {
            method = rubyInterpreter {
                path = "%path.to.inverpreter%"
            }
        }
Content copied to clipboard
    }
}

Example. Adds a Ruby Environment Configurator build feature with specified RVM interpreter.

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        rubyEnvConfigurator {
            method = interpreterAndGemset {
                interpreter = "jruby-1.4.0"
                gemset = "gemset"
                requireRVM = true
            }
        }
Content copied to clipboard
    }
}

Example. Adds a Ruby Environment Configurator build feature with specified RVM with .rvmrc file.

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        rubyEnvConfigurator {
            method = rvmrc {
                path = "rubyProject/.rvmrc"
                requireRVM = true
            }
        }
Content copied to clipboard
    }
}

Example. Adds a Ruby Environment Configurator build feature with specified RVM with .rvmrc file and a path to a directory with .ruby-version or .rbenv-version file relative to a checkout directory.

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        rubyEnvConfigurator {
            method = rvmConfigDirectory {
                path = "rubyProject"
                requireRVM = true
            }
        }
Content copied to clipboard
    }
}

Example. Adds a Ruby Environment Configurator build feature with specified rbenv.

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        rubyEnvConfigurator {
            method = rbenv {
                interpreterVersion = "jruby-1.7.0"
                requireRbenv = true
            }
            failIfInterpreterNotFound = false
        }
Content copied to clipboard
    }
}

Example. Adds a Ruby Environment Configurator build feature with specified rbenv configuration directory and a path to a directory with .ruby-version or .rbenv-version file relative to a checkout directory.

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        rubyEnvConfigurator {
            method = rbenvConfigDirectory {
                path = "rubyProject"
                requireRbenv = true
            }
        }
Content copied to clipboard
    }
}

Constructors

RubyEnvConfigurator

constructor(init: RubyEnvConfigurator.() -> Unit)

constructor()

Types

Method

sealed class Method : CompoundParam<RubyEnvConfigurator.Method>

Properties

enabled

var enabled: Boolean

Specifies whether the feature is enabled, true by default

failIfInterpreterNotFound

var failIfInterpreterNotFound: Boolean?

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

var id: String?

Build feature id, if not specified will be generated

method

var method: RubyEnvConfigurator.Method?

Ruby Environment Configurator method.

params

val params: List<Parameter>

type

var type: String

Build feature type

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): BuildFeature

Creates an instance of this build feature via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

doubleParameter