TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildSteps/XcodeStep

XcodeStep

fun BuildSteps.xcode(init: XcodeStep.() -> Unit): XcodeStep

An Xcode build step for running Xcode projects.

Example. Adds an Xcode build step with a scheme-based build.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        xcode {
            name = "My Xcode step"
            projectPath = "SampleProject.xcodeproj"
            buildType = schemeBased {
                scheme = "SampleProject"
                outputDirectory = default()
            }
        }
Content copied to clipboard
    }
}

Example. Adds an Xcode build step with a scheme-based build with custom working directory, with custom Xcode path, output directory, build actions and additional command line parameters.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        xcode {
            name = "My Xcode step"
            workingDir = "project"
            projectPath = "project/SampleProject.xcodeproj"
            xcodePath = "path/to/Xcode"
            buildType = schemeBased {
                scheme = "SampleProject"
                outputDirectory = custom {
                    path = "outputDir"
                }
            }
            buildActions = "clean build"
            runTests = true
            additionalCommandLineParameters = "-quiet"
        }
Content copied to clipboard
    }
}

Example. Adds an Xcode build step with a target-based build.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        xcode {
            name = "My Xcode step"
            projectPath = "SampleProject.xcodeproj"
            buildType = targetBased {
                target = "MyTarget"
                configuration = "Debug"
                platform = "macosx"  // ... "iphoneos", "iphonesimulator"
                sdk = "mySDK"
                architecture = "myArchitecture"
            }
            buildActions = "clean build"
            runTests = true
        }
Content copied to clipboard
    }
}

Constructors

XcodeStep

fun XcodeStep(init: XcodeStep.() -> Unit)

XcodeStep

fun XcodeStep()

Types

BuildType

sealed class BuildType : CompoundParam<XcodeStep.BuildType>

Functions

booleanParameter

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

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

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

conditions

fun conditions(init: BuildStepConditions.() -> Unit = {})

Configures build step conditions

copyParamsTo

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

Copies parameters of this object to the specified target

create

open fun create(): BuildStep

Creates an instance of this build step 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

fun doubleParameter(customName: String? = null): SingleDelegateProvider<Double>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): SingleDelegateProvider<E>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): SingleDelegateProvider<Int>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String)

schemeBased

fun schemeBased(init: XcodeStep.BuildType.SchemeBased.() -> Unit = {}): XcodeStep.BuildType.SchemeBased

stringParameter

fun stringParameter(customName: String? = null): SingleDelegateProvider<String>

targetBased

fun targetBased(init: XcodeStep.BuildType.TargetBased.() -> Unit = {}): XcodeStep.BuildType.TargetBased

toString

open override fun toString(): String

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

additionalCommandLineParameters

var additionalCommandLineParameters: String?

Other command line parameters to be passed to the xcodebuild utility.

buildActions

var buildActions: String?

Xcode build action(s). The default actions are clean and build. A space-separated list of the following actions is supported: clean, build, test, archive, installsrc, install; the order of actions will be preserved during execution. It is not recommended changing this field unless you are sure you want to change the number or order of actions. If your project is built under Xcode 5+, setting the runTests option automatically adds the test build action to the list (unless the option is already explicitly specified in the current field).

buildType

var buildType: XcodeStep.BuildType?

Select either a target-based (for project) or scheme-based (for project and workspace) build. Depending on the selection, the settings will vary.

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

enabled

var enabled: Boolean = true

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

var id: String? = null

Optional id of the step. Usually the id is not required, however if a build configuration inherits from a template and wants to override a build step defined there, then both steps should have the same id.

name

var name: String

Build step name

params

val params: List<Parameter>

projectPath

var projectPath: String?

The path to a (.xcodeproj) project file or a (.xcworkspace) workspace file, should be relative to the checkout directory. For Xcode 3 build, only the path to the project file is supported.

runTests

var runTests: Boolean?

Whether to run tests after your project is built.

type

var type: String

Build step type

workingDir

var workingDir: String?

Build working directory for the executable, specify it if it is different from the checkout directory.

xcodePath

var xcodePath: String?

The path to Xcode on the agent. The build will be run using this Xcode.