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

NuGetPackStep

fun BuildSteps.nuGetPack(init: NuGetPackStep.() -> Unit): NuGetPackStep

A NuGet pack step to run nuget pack command

Example. Creates NuGet packages according to provided .nuspec files. Uses the default NuGet tool version installed on the TeamCity server. Publishes created packages as TeamCity artifacts.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        nuGetPack {
          toolPath = "%teamcity.tool.NuGet.CommandLine.DEFAULT%"
          paths = """
            main-packages/packages.nuspec
            supplemental/packages.nuspec
          """.trimIndent()
          outputDir = "target"
          cleanOutputDir = true
          publishPackages = true
        }
Content copied to clipboard
    }
}

Constructors

NuGetPackStep

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

constructor()

Types

BaseDir

sealed class BaseDir : CompoundParam<NuGetPackStep.BaseDir>

Properties

args

var args: String?

Enter additional parameters to use when calling nuget pack command.

baseDir

var baseDir: NuGetPackStep.BaseDir?

The -BaseDirectory parameter value. Leave blank to use the build checkout directory

cleanOutputDir

var cleanOutputDir: Boolean?

Clean output directory

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

enabled

var enabled: Boolean

Specifies whether the step is enabled, true by default

excludePaths

var excludePaths: String?

Exclude files when creating a package.

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

var id: String?

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.

includeSymbols

var includeSymbols: Boolean?

Include sources and symbols.

name

var name: String

Build step name

outputDir

var outputDir: String?

The path to the output directory for generated NuGet packages.

params

val params: List<Parameter>

paths

var paths: String?

Specify paths to .nuspec files and/or to project files.

preferProjectPaths

var preferProjectPaths: Boolean?

Use the project file (if exists, i.e. .csproj or .vbproj) for every matched .nuspec file.

properties

var properties: String?

A semicolon or a newline-separated list of package creation properties.

publishPackages

var publishPackages: Boolean?

Publish created packages to build artifacts

toolPackage

var toolPackage: Boolean?

Create tool package.

toolPath

var toolPath: String?

Specify path to NuGet.exe.

type

var type: String

Build step type

version

var version: String?

Overrides the version number from the .nuspec file.

Functions

booleanParameter

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

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<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.

customPath