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

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

NodeJSBuildStep

fun NodeJSBuildStep()

Types

ImagePlatform

enum ImagePlatform : Enum<NodeJSBuildStep.ImagePlatform>

Docker image platforms

Functions

booleanParameter

fun booleanParameter( customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, 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): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

open fun stringParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

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

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

dockerImage

var dockerImage: <ERROR CLASS>

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: <ERROR CLASS>

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

dockerPull

var dockerPull: <ERROR CLASS>

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

dockerRunParameters

var dockerRunParameters: <ERROR CLASS>

Additional docker run command arguments

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

params