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

NodeJSBuildStep

fun BuildSteps.nodeJS(init: NodeJSBuildStep.() -> Unit): NodeJSBuildStep

A Node.js build step

Example. Adds a Node.js build step with specified script commands, that will be running in Node.js LTS Docker container.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        nodeJS {
            name = "Node.js test"
            shellScript = """
                npm ci
                npm run test
            """.trimIndent()
        }
Content copied to clipboard
    }
}

Example. Adds a Node.js build step with specified script commands, that will be running in specified Node.js Docker container, in custom working directory. This build step will run even if some previous build steps are failed.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        nodeJS {
            name = "Node.js test"
            executionMode = BuildStep.ExecutionMode.RUN_ON_FAILURE
            workingDir = "frontend"
            shellScript = """
                npm ci
                npm run test
            """.trimIndent()
            dockerImage = "node:18"
        }
Content copied to clipboard
    }
}

Constructors

NodeJSBuildStep

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

constructor()

Types

ImagePlatform

enum ImagePlatform : Enum<NodeJSBuildStep.ImagePlatform>

Docker image platforms

Properties

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

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: NodeJSBuildStep.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.

name

var name: String

Build step name

params

val params: List<Parameter>

shellScript

var shellScript: String?

Shell commands for running Node.js projects

type

var type: String

Build step type

workingDir

var workingDir: String?

Build working directory for commands run, 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