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

NuGetPublishStep

fun BuildSteps.nuGetPublish(init: NuGetPublishStep.() -> Unit): NuGetPublishStep

A NuGet publish step to run nuget push command

Example. Publishes "target/app.nupkg" NuGet package to "https://api.nuget.org/v3/index.json" NuGet feed. Uses the specified API key for the publishing. Note: instead of an actual API key a token should be provided.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        nuGetPublish {
          toolPath = "%teamcity.tool.NuGet.CommandLine.DEFAULT%"
          packages = "target/app.nupkg"
          serverUrl = "https://api.nuget.org/v3/index.json"
          apiKey = "<a token for an API key>"
        }
Content copied to clipboard
    }
}

Constructors

NuGetPublishStep

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

NuGetPublishStep

fun NuGetPublishStep()

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)

stringParameter

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

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

apiKey

var apiKey: String?

Specify the API key to access a NuGet packages feed.

args

var args: String?

Enter additional parameters to use when calling nuget push 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.

name

var name: String

Build step name

packages

var packages: String?

A newline-separated list of NuGet package files (.nupkg) to push to the NuGet feed.

params