TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildFeatures/NpmConnectionBuildFeature

NpmConnectionBuildFeature

open class NpmConnectionBuildFeature : BuildFeature

fun BuildFeatures.npmRegistry(init: NpmConnectionBuildFeature.() -> Unit): NpmConnectionBuildFeature

Adds a connection to npm registry to build.

Example. Adds an npm registry build feature. Please note that corresponding connection project feature should be provided in project. This connection will be used only inside nodeJS build steps.

project {
    // ...
    buildType(Build)

    features {
        npmRegistry {
            id = "PROJECT_EXT_NPM_REG"
            name = "NPM Registry"
            scope = "scope"
            token = "credentialsJSON:xxx"
        }
    }
}

object Build : BuildType({
    name = "Build"
    // ...
    features {
        npmRegistry {
            connectionId = "PROJECT_EXT_NPM_REG"
        }
    }

    steps {
        nodeJS {
            shellScript = """
                npm ci
                npm run test
            """.trimIndent()
        }
    }
})

Constructors

NpmConnectionBuildFeature

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

constructor()

Properties

connectionId

var connectionId: String?

enabled

var enabled: Boolean

Specifies whether the feature is enabled, true by default

var id: String?

Build feature id, if not specified will be generated

params

val params: List<Parameter>

type

var type: String

Build feature type

Functions

booleanParameter

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

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): BuildFeature

Creates an instance of this build feature 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