Class DockerPlugin

constructor

• new DockerPlugin(): DockerPlugin

  Returns DockerPlugin

StaticPLUGIN

addCommand

• addCommand(command: string): this

  Parameters

  • command: string

  Returns this

addEnvironment

• addEnvironment(environment: string): this

  Parameters

  • environment: string

  Returns this

addVolume

• addVolume(volume: string): this

  Parameters

  • volume: string

  Returns this

alwaysPull

• alwaysPull(alwaysPull?: boolean): this

  Parameters

  • alwaysPull: boolean = true

  Returns this

  Deprecated

  Use .setAlwaysPull() instead

build

• build(): PluginSchema | Promise<PluginSchema>

  Returns PluginSchema | Promise<PluginSchema>

command

• command(command: string): this

  Parameters

  • command: string

  Returns this

  Deprecated

  Use .addCommand() instead

cpus

• cpus(cpus: string): this

  Parameters

  • cpus: string

  Returns this

  Deprecated

  Use .setCPUs() instead

debug

• debug(debug?: boolean): this

  Parameters

  • debug: boolean = true

  Returns this

  Deprecated

  Use .setDebug() instead

entrypoint

• entrypoint(entrypoint: string): this

  Parameters

  • entrypoint: string

  Returns this

  Deprecated

  Use .addCommand() instead

environment

• environment(environment: string): this

  Parameters

  • environment: string

  Returns this

  Deprecated

  Use .addEnvironment() instead

getAlwaysPull

• getAlwaysPull(): boolean | undefined

  Returns boolean | undefined

getCommands

• getCommands(): readonly string[]

  Returns readonly string[]

getDebug

• getDebug(): boolean | undefined

  Returns boolean | undefined

getEntrypoint

• getEntrypoint(): string | undefined

  Returns string | undefined

getEnvironment

• getEnvironment(): readonly string[]

  Returns readonly string[]

getImage

• getImage(): string | undefined

  Returns string | undefined

getMountBuildkiteAgent

• getMountBuildkiteAgent(): boolean | undefined

  Returns boolean | undefined

getMountCheckout

• getMountCheckout(): boolean | undefined

  Returns boolean | undefined

getMountSSHAgent

• getMountSSHAgent(): boolean | undefined

  Returns boolean | undefined

getPlatform

• getPlatform(): string | undefined

  Returns string | undefined

getPropagateAWSAauthTokens

• getPropagateAWSAauthTokens(): boolean | undefined

  Returns boolean | undefined

getPropagateEnvironment

• getPropagateEnvironment(): boolean | undefined

  Returns boolean | undefined

getShell

• getShell(): string[] | undefined

  Returns string[] | undefined

getVolumes

• getVolumes(): readonly string[]

  Returns readonly string[]

image

• image(image: string): DockerPlugin

  Parameters

  • image: string

  Returns DockerPlugin

  Deprecated

  Use .setImage() instead

memory

• memory(memory: string): this

  Parameters

  • memory: string

  Returns this

  Deprecated

  Use .setMemory() instead

memorySwap

• memorySwap(swap: string): this

  Parameters

  • swap: string

  Returns this

  Deprecated

  Use .setMemorySwap() instead

memorySwapiness

• memorySwapiness(swappiness: string): this

  Parameters

  • swappiness: string

  Returns this

  Deprecated

  Use .setMemorySwapiness() instead

mountBuildkiteAgent

• mountBuildkiteAgent(mount?: boolean): this

  Parameters

  • mount: boolean = true

  Returns this

  Deprecated

  Use .setMountBuildkiteAgent() instead

mountCheckout

• mountCheckout(mount?: boolean): this

  Parameters

  • mount: boolean = true

  Returns this

  Deprecated

  Use .setMountCheckout() instead

mountSSHAgent

• mountSSHAgent(mount?: boolean): this

  Parameters

  • mount: boolean = true

  Returns this

  Deprecated

  Use .setMountSSHAgent() instead

platform

• platform(platform: string): this

  Parameters

  • platform: string

  Returns this

  Deprecated

  Use .setPlatform() instead

propagateAWSAuthTokens

• propagateAWSAuthTokens(propagate?: boolean): this

  Parameters

  • propagate: boolean = true

  Returns this

  Deprecated

  Use .setPropagateAWSAuthTokens() instead

propagateEnvironment

• propagateEnvironment(propagate?: boolean): this

  Parameters

  • propagate: boolean = true

  Returns this

  Deprecated

  Use .setPropagateEnvironment() instead

setAlwaysPull

• setAlwaysPull(alwaysPull: boolean): this

  Parameters

  • alwaysPull: boolean

  Returns this

setCPUs

• setCPUs(cpus: string): this

  Parameters

  • cpus: string

  Returns this

setDebug

• setDebug(debug: boolean): this

  Parameters

  • debug: boolean

  Returns this

setEntrypoint

• setEntrypoint(entrypoint: string): this

  Parameters

  • entrypoint: string

  Returns this

setExpandVolumeVars

• setExpandVolumeVars(expand: boolean): this

  Parameters

  • expand: boolean

  Returns this

setImage

• setImage(image: string): DockerPlugin

  Parameters

  • image: string

  Returns DockerPlugin

setMemory

• setMemory(memory: string): this

  Parameters

  • memory: string

  Returns this

setMemorySwap

• setMemorySwap(swap: string): this

  Parameters

  • swap: string

  Returns this

setMemorySwapiness

• setMemorySwapiness(swappiness: string): this

  Parameters

  • swappiness: string

  Returns this

setMountBuildkiteAgent

• setMountBuildkiteAgent(mount: boolean): this

  Parameters

  • mount: boolean

  Returns this

setMountCheckout

• setMountCheckout(mount?: boolean): this

  Parameters

  • mount: boolean = true

  Returns this

setMountSSHAgent

• setMountSSHAgent(mount: boolean): this

  Parameters

  • mount: boolean

  Returns this

setPlatform

• setPlatform(platform: string): this

  Parameters

  • platform: string

  Returns this

setPropagateAWSAauthTokens

• setPropagateAWSAauthTokens(propagate: boolean): this

  Parameters

  • propagate: boolean

  Returns this

  Deprecated

  Use .setPropagateAWSAuthTokens() instead

setPropagateAWSAuthTokens

• setPropagateAWSAuthTokens(propagate: boolean): this

  Parameters

  • propagate: boolean

  Returns this

setPropagateEnvironment

• setPropagateEnvironment(propagate: boolean): this

  Parameters

  • propagate: boolean

  Returns this

setShell

• setShell(cmd: string, args?: string[]): this

  Parameters

  • cmd: string
  • args: string[] = []

  Returns this

setUser

• setUser(user: string): this

  Parameters

  • user: string

  Returns this

setUserns

• setUserns(namespace: string): this

  Parameters

  • namespace: string

  Returns this

setWorkdir

• setWorkdir(workdir: string): this

  Parameters

  • workdir: string

  Returns this

shell

• shell(cmd: string, args?: string[]): this

  Parameters

  • cmd: string
  • args: string[] = []

  Returns this

  Deprecated

  Use .setPlatform() instead

user

• user(user: string): this

  Parameters

  • user: string

  Returns this

  Deprecated

  Use .setUser() instead

userns

• userns(namespace: string): this

  Parameters

  • namespace: string

  Returns this

  Deprecated

  Use .setUserNamespace() instead

volume

• volume(volume: string): this

  Parameters

  • volume: string

  Returns this

  Deprecated

  Use .addVolume() instead

workdir

• workdir(workdir: string): this

  Parameters

  • workdir: string

  Returns this

  Deprecated

  Use .setWorkdir() instead