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

NuGetInstallerStep

open class NuGetInstallerStep : BuildStep

fun BuildSteps.nuGetInstaller(init: NuGetInstallerStep.() -> Unit): NuGetInstallerStep

A NuGet installer step to run nuget restore command

Example. Installs all NuGet packages referenced in the Visual Studio solution file "my_solution.sln" including the pre-release packages. Uses the default NuGet tool version installed on the TeamCity server.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        nuGetInstaller {
          toolPath = "%teamcity.tool.NuGet.CommandLine.DEFAULT%"
          projects = "my_solution.sln"
          updatePackages = updateParams {
            includePreRelease = true
          }
        }
Content copied to clipboard
    }
}

Example. Installs all NuGet packages referenced in the Visual Studio solution file "my_solution.sln". Uses a custom path to the NuGet executable.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        nuGetInstaller {
          toolPath = "<path to NuGet executable on agent>"
          projects = "my_solution.sln"
        }
Content copied to clipboard
    }
}

Constructors

NuGetInstallerStep

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

NuGetInstallerStep

fun NuGetInstallerStep()

Types

Mode

sealed class Mode : CompoundParam<NuGetInstallerStep.Mode>

UpdateMode

enum UpdateMode : Enum<NuGetInstallerStep.UpdateMode>

Update mode

UpdatePackages

sealed class UpdatePackages : CompoundParam<NuGetInstallerStep.UpdatePackages>

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

install

fun install(init: NuGetInstallerStep.Mode.Install.() -> Unit = {}): NuGetInstallerStep.Mode.Install

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)

stringParameter

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

toString

open override fun toString(): String

updateParams

fun updateParams(init: NuGetInstallerStep.UpdatePackages.UpdateParams.() -> Unit = {}): NuGetInstallerStep.UpdatePackages.UpdateParams

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

args

var args: String?

Enter additional parameters to use when calling nuget pack command.

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.

mode

var mode: NuGetInstallerStep.Mode?

Select NuGet.exe restore or NuGet.exe install command to restore packages

name

var name: String

Build step name

noCache

var noCache: Boolean?

Disable looking up packages from local machine cache.

params