NuGetPackStep

open class NuGetPackStep : BuildStep
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
        }
} }

See also

Constructors

Link copied to clipboard
fun NuGetPackStep(init: NuGetPackStep.() -> Unit)
Link copied to clipboard
fun NuGetPackStep()

Types

Link copied to clipboard
sealed class BaseDir : CompoundParam<NuGetPackStep.BaseDir>

Functions

Link copied to clipboard
fun booleanParameter(    customName: String? = null,     trueValue: String? = "true",     falseValue: String? = "false"): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun clearConditions()

Deletes all configured build step conditions

Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun conditions(init: BuildStepConditions.() -> Unit = {})
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard
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.

Link copied to clipboard
fun customPath(init: NuGetPackStep.BaseDir.CustomPath.() -> Unit = {}): NuGetPackStep.BaseDir.CustomPath
Link copied to clipboard
fun doubleParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun projectPath(): NuGetPackStep.BaseDir.ProjectPath

Use project/.nuspec directory.

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
open fun stringParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

Link copied to clipboard
var args: <ERROR CLASS>

Enter additional parameters to use when calling nuget pack command.

Link copied to clipboard
var baseDir: <ERROR CLASS>

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

Link copied to clipboard
var cleanOutputDir: <ERROR CLASS>

Clean output directory

Link copied to clipboard
var conditions: BuildStepConditions

Optional collection of build step execution conditions

Link copied to clipboard
var enabled: Boolean = true

Specifies whether the step is enabled, true by default

Link copied to clipboard
var excludePaths: <ERROR CLASS>

Exclude files when creating a package.

Link copied to clipboard
var executionMode: BuildStep.ExecutionMode

Build step execution mode

Link copied to clipboard
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.

Link copied to clipboard
var includeSymbols: <ERROR CLASS>

Include sources and symbols.

Link copied to clipboard
var name: String

Build step name

Link copied to clipboard
var outputDir: <ERROR CLASS>

The path to the output directory for generated NuGet packages.

Link copied to clipboard
val params: List<Parameter>
Link copied to clipboard
var paths: <ERROR CLASS>

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

Link copied to clipboard
var preferProjectPaths: <ERROR CLASS>

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

Link copied to clipboard
var properties: <ERROR CLASS>

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

Link copied to clipboard
var publishPackages: <ERROR CLASS>

Publish created packages to build artifacts

Link copied to clipboard
var toolPackage: <ERROR CLASS>

Create tool package.

Link copied to clipboard
var toolPath: <ERROR CLASS>

Specify path to NuGet.exe.

Link copied to clipboard
var type: String

Build step type

Link copied to clipboard
var version: <ERROR CLASS>

Overrides the version number from the .nuspec file.