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

DotnetRestoreStep

open class DotnetRestoreStep : BuildStep

fun BuildSteps.dotnetRestore(init: DotnetRestoreStep.() -> Unit): DotnetRestoreStep

A dotnet restore step to run .NET CLI command

Example. Runs dotnet restore command for the MyProject.sln solution file.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        dotnetRestore {
            projects = "MyProject.sln"
        }
Content copied to clipboard
    }
}

Constructors

DotnetRestoreStep

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

constructor()

Types

ImagePlatform

enum ImagePlatform : Enum<DotnetRestoreStep.ImagePlatform>

Docker image platforms

Verbosity

enum Verbosity : Enum<DotnetRestoreStep.Verbosity>

Logging verbosity

Properties

args

var args: String?

Enter additional command line parameters for dotnet restore.

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

configFile

var configFile: String?

The NuGet configuration file to use.

dockerImage

var dockerImage: String?

Specifies which Docker image to use for running this build step. I.e. the build step will be run inside specified docker image, using 'docker run' wrapper.

dockerImagePlatform

var dockerImagePlatform: DotnetRestoreStep.ImagePlatform?

Specifies which Docker image platform will be used to run this build step.

dockerPull

var dockerPull: Boolean?

If enabled, "pull image" command will be run before docker run.

dockerRunParameters

var dockerRunParameters: String?

Additional docker run command arguments

enabled

var enabled: Boolean

Specifies whether the step is enabled, true by default

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.

logging

var logging: DotnetRestoreStep.Verbosity?

Specify logging verbosity

name

var name: String

Build step name

packagesDir

var packagesDir: String?

The directory to restore packages.

params

val params: List<Parameter>

projects

var projects: String?

Specify paths to projects and solutions. Wildcards are supported.

runtime

var runtime: String?

Target runtime to restore packages.

sdk

var sdk: String?

.NET SDK versions separated by semicolon to be required on agents.

sources

var sources: String?

Specifies NuGet package sources to use during the restore.

type

var type: String

Build step type

workingDir

var workingDir: String?

Build working directory for script, specify it if it is different from the checkout * directory.

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.

doubleParameter