TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.triggers/NuGetDependency

NuGetDependency

fun Triggers.nuGetDependency(init: NuGetDependency.() -> Unit): NuGetDependency

The NuGet Dependency Trigger allows starting a new build if a NuGet packages update is detected in the NuGet repository. Note that if a custom NuGet executable is used, it must be explicitly allowed on this server.

Example. Watches for a change of the package with specified id in the specified NuGet feed. Uses the specified credentials to access the feed and the default NuGet executable installed on the TeamCity server. Note: instead of an actual password a token should be provided.

buildType {
    // Other Build Type settings ...
    triggers {
        // Other Triggers ...
        nuGetDependency {
          nugetPath = "%teamcity.tool.NuGet.CommandLine.DEFAULT%"
          feedURL = "<NuGet feed URL>"
          packageId = "<NuGet package id>"
          username = "user"
          password = "<a token representing a password>"
        }
Content copied to clipboard
    }
}

Constructors

NuGetDependency

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

constructor()

Properties

buildParams

val buildParams: TriggerBuildParameters

Parameters that are added to triggered builds

enabled

var enabled: Boolean

Specifies whether the trigger is enabled

enforceCleanCheckout

var enforceCleanCheckout: Boolean

Whether the build should be triggered with clean checkout

enforceCleanCheckoutForDependencies

var enforceCleanCheckoutForDependencies: Boolean

When the enforceCleanCheckout is set to true specifies whether the clean checkout should also be applied to all dependencies.

feedURL

var feedURL: String?

The NuGet packages feed URL to monitor packages changes. Leave blank to use default NuGet feed.

var id: String?

Trigger id, if not set will be generated

includePrerelease

var includePrerelease: Boolean?

Trigger build if pre-release package version is detected.

nugetPath

var nugetPath: String?

A custom path to NuGet.exe. Absolute paths are supported. It can reference to Nuget.exe Tool installed via Administration | Tools.

packageId

var packageId: String?

A Package Id to check for updates.

packageVersion

var packageVersion: String?

Specify package version to check. Leave empty to check for latest version.

params

val params: List<Parameter>

password

var password: String?

A password to access NuGet feed, leave blank if no authentication is required.

type

var type: String

Trigger type

username

var username: String?

A username to access NuGet feed, leave blank if no authentication is required.

Functions

booleanParameter

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

buildParams

fun buildParams(init: TriggerBuildParameters.() -> Unit)

Configures build parameters that are applied to triggered builds

clear

fun clear()

clearBuildParams

fun clearBuildParams()

Deletes all configured build parameters

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(): Trigger

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