Class CommandStep

Implements

StepBuilder
KeyBuilder
LabelBuilder
ConditionBuilder
BranchFilterBuilder
DependenciesBuilder
SkipBuilder
AgentsBuilder
EnvironmentBuilder

Constructors

constructor

new CommandStep(): CommandStep
Returns CommandStep

Methods

addAgent

addAgent(tag: string, value: string): this
Parameters
- tag: string
- value: string
Returns this
Implementation of AgentsBuilder.addAgent
- Defined in builders/CommandStep.ts:347

addAutomaticRetry

addAutomaticRetry(retry: AutomaticRetry): this
Parameters
- retry: AutomaticRetry
Returns this
- Defined in builders/CommandStep.ts:365

addBranch

addBranch(branch: string): this
Parameters
- branch: string
Returns this
Implementation of BranchFilterBuilder.addBranch
- Defined in builders/CommandStep.ts:127

addCommand

addCommand(command: string): this
Parameters
- command: string
Returns this
- Defined in builders/CommandStep.ts:60

addDependency

addDependency(
dependency: string | { allow_failure?: boolean; step?: string },
): this
Parameters
- dependency: string | { allow_failure?: boolean; step?: string }
Returns this
Implementation of DependenciesBuilder.addDependency
- Defined in builders/CommandStep.ts:143

addEnv

addEnv(name: string, value: unknown): this
Parameters
- name: string
- value: unknown
Returns this
Implementation of EnvironmentBuilder.addEnv
- Defined in builders/CommandStep.ts:235

addPlugin

addPlugin(plugin: PluginSchema | PluginBuilder): this
Parameters
- plugin: PluginSchema | PluginBuilder
Returns this
- Defined in builders/CommandStep.ts:188

addPlugins

addPlugins(plugins: Iterable<PluginSchema | PluginBuilder>): this
Parameters
- plugins: Iterable<PluginSchema | PluginBuilder>
Returns this
- Defined in builders/CommandStep.ts:200

agent

agent(tag: string, value: string): this
Parameters
- tag: string
- value: string
Returns this
Deprecated
Use .addAgent() instead
Implementation of AgentsBuilder.agent
- Defined in builders/CommandStep.ts:343

allowDependencyFailure

allowDependencyFailure(allow: boolean): this
Parameters
- allow: boolean
Returns this
Deprecated
Use .addDependency() instead
Implementation of DependenciesBuilder.allowDependencyFailure
- Defined in builders/CommandStep.ts:151

branch

branch(branch: string): this
Parameters
- branch: string
Returns this
Deprecated
Use .addBranch() instead
Implementation of BranchFilterBuilder.branch
- Defined in builders/CommandStep.ts:123

build

build(): Promise<CommandStepSchema>
Returns Promise<CommandStepSchema>
Implementation of StepBuilder.build
- Defined in builders/CommandStep.ts:370

command

command(command: string): this
Parameters
- command: string
Returns this
Deprecated
Use .addCommand() instead
- Defined in builders/CommandStep.ts:56

concurrency

concurrency(group: string, jobs: number): this
Parameters
- group: string
- jobs: number
Returns this
Deprecated
Use .setConcurrency() instead
- Defined in builders/CommandStep.ts:250

condition

condition(condition: string): this
Parameters
- condition: string
Returns this
Deprecated
Use .setCondition() instead
Implementation of ConditionBuilder.condition
- Defined in builders/CommandStep.ts:107

dependOn

dependOn(dependency: string | { allow_failure?: boolean; step?: string }): this
Parameters
- dependency: string | { allow_failure?: boolean; step?: string }
Returns this
Deprecated
Use .addDependency() instead
Implementation of DependenciesBuilder.dependOn
- Defined in builders/CommandStep.ts:139

env

env(name: string, value: unknown): this
Parameters
- name: string
- value: unknown
Returns this
Deprecated
Use .addEnv() instead
- Defined in builders/CommandStep.ts:231

getAgents

getAgents(): Readonly<Record<string, string>>
Returns Readonly<Record<string, string>>
Implementation of AgentsBuilder.getAgents
- Defined in builders/CommandStep.ts:336

getAutomaticRetries

getAutomaticRetries(): AutomaticRetry[]
Returns AutomaticRetry[]
- Defined in builders/CommandStep.ts:361

getBranches

getBranches(): readonly string[]
Returns readonly string[]
Implementation of BranchFilterBuilder.getBranches
- Defined in builders/CommandStep.ts:116

getCommands

getCommands(): Iterable<string>
Returns Iterable<string>
- Defined in builders/CommandStep.ts:49

getConcurrency

getConcurrency(): number | undefined
Returns number | undefined
See
https://buildkite.com/docs/pipelines/configure/workflows/controlling-concurrency#concurrency-limits
- Defined in builders/CommandStep.ts:243

getConcurrencyGroup

getConcurrencyGroup(): string | undefined
Returns string | undefined
See
https://buildkite.com/docs/pipelines/configure/workflows/controlling-concurrency#concurrency-groups
- Defined in builders/CommandStep.ts:292

getCondition

getCondition(): string | undefined
Returns string | undefined
Implementation of ConditionBuilder.getCondition
- Defined in builders/CommandStep.ts:100

getDependencies

getDependencies(): readonly (
string
| { allow_failure?: boolean; step?: string }
)[]
Returns readonly (string | { allow_failure?: boolean; step?: string })[]
Implementation of DependenciesBuilder.getDependencies
- Defined in builders/CommandStep.ts:132

getEnv

getEnv(): Readonly<Record<string, unknown>>
Returns Readonly<Record<string, unknown>>
Implementation of EnvironmentBuilder.getEnv
- Defined in builders/CommandStep.ts:224

getKey

getKey(): string | undefined
Returns string | undefined
Implementation of KeyBuilder.getKey
- Defined in builders/CommandStep.ts:68

getLabel

getLabel(): string | undefined
Returns string | undefined
Implementation of LabelBuilder.getLabel
- Defined in builders/CommandStep.ts:84

getManualRetry

getManualRetry(): | boolean
| { allowed?: boolean; permit_on_passed?: boolean; reason?: string }
| undefined
Returns
    | boolean
    | { allowed?: boolean; permit_on_passed?: boolean; reason?: string }
    | undefined
- boolean
- { allowed?: boolean; permit_on_passed?: boolean; reason?: string }
  - Optionalallowed?: boolean
    Whether or not this job can be retried manually
  - Optionalpermit_on_passed?: boolean
    Whether or not this job can be retried after it has passed
  - Optionalreason?: string
    A string that will be displayed in a tooltip on the Retry button in Buildkite. This will only be displayed if the allowed attribute is set to false.
- undefined
- Defined in builders/CommandStep.ts:352

getParallelism

getParallelism(): number | undefined
Returns number | undefined
- Defined in builders/CommandStep.ts:205

getPlugins

getPlugins(): Iterable<PluginSchema | PluginBuilder>
Returns Iterable<PluginSchema | PluginBuilder>
- Defined in builders/CommandStep.ts:176

getSkip

getSkip(): string | boolean | undefined
Returns string | boolean | undefined
- Defined in builders/CommandStep.ts:160

getSoftFail

getSoftFail(): boolean | undefined
Returns boolean | undefined
- Defined in builders/CommandStep.ts:304

getTimeout

getTimeout(): number | undefined
Returns number | undefined
- Defined in builders/CommandStep.ts:320

key

key(key: string): this
Parameters
- key: string
Returns this
Deprecated
Use .setKey() instead
Implementation of KeyBuilder.key
- Defined in builders/CommandStep.ts:75

label

label(label: string): this
Parameters
- label: string
Returns this
Deprecated
Use .setLabel() instead
Implementation of LabelBuilder.label
- Defined in builders/CommandStep.ts:91

parallelism

parallelism(parallelism: number): this
Parameters
- parallelism: number
Returns this
Deprecated
Use .setParallelism() instead
- Defined in builders/CommandStep.ts:212

plugin

plugin(plugin: PluginSchema | PluginBuilder): this
Parameters
- plugin: PluginSchema | PluginBuilder
Returns this
Deprecated
Use .addPlugin() instead
- Defined in builders/CommandStep.ts:184

plugins

plugins(plugins: Iterable<PluginSchema | PluginBuilder>): this
Parameters
- plugins: Iterable<PluginSchema | PluginBuilder>
Returns this
Deprecated
Use .addPlugins() instead
- Defined in builders/CommandStep.ts:196

setAllowDependencyFailure

setAllowDependencyFailure(allow: boolean): this
Parameters
- allow: boolean
Returns this
Implementation of DependenciesBuilder.setAllowDependencyFailure
- Defined in builders/CommandStep.ts:155

setConcurrency

setConcurrency(concurrency: number): this
Parameters
- concurrency: number
Returns this
See
https://buildkite.com/docs/pipelines/configure/workflows/controlling-concurrency#concurrency-limits
- Defined in builders/CommandStep.ts:257
setConcurrency(group: string, jobs: number): this
Parameters
- group: string
- jobs: number
Returns this
Deprecated
Use .setConcurrency() and .setConcurrencyGroup() instead
- Defined in builders/CommandStep.ts:259

setConcurrencyGroup

setConcurrencyGroup(group: string): this
Parameters
- group: string
Returns this
See
https://buildkite.com/docs/pipelines/configure/workflows/controlling-concurrency#concurrency-groups
- Defined in builders/CommandStep.ts:299

setCondition

setCondition(condition: string): this
Parameters
- condition: string
Returns this
Implementation of ConditionBuilder.setCondition
- Defined in builders/CommandStep.ts:111

setKey

setKey(key: string): this
Parameters
- key: string
Returns this
Implementation of KeyBuilder.setKey
- Defined in builders/CommandStep.ts:79

setLabel

setLabel(label: string): this
Parameters
- label: string
Returns this
Implementation of LabelBuilder.setLabel
- Defined in builders/CommandStep.ts:95

setManualRetry

setManualRetry(
    retry:
        | boolean
        | { allowed?: boolean; permit_on_passed?: boolean; reason?: string }
        | undefined,
): this
Parameters
- retry:
      | boolean
      | { allowed?: boolean; permit_on_passed?: boolean; reason?: string }
      | undefined
  - boolean
  - { allowed?: boolean; permit_on_passed?: boolean; reason?: string }
    Optionalallowed?: boolean
    Whether or not this job can be retried manually
    
    Optionalpermit_on_passed?: boolean
    Whether or not this job can be retried after it has passed
    
    Optionalreason?: string
    A string that will be displayed in a tooltip on the Retry button in Buildkite. This will only be displayed if the allowed attribute is set to false.
  - undefined
Returns this
- Defined in builders/CommandStep.ts:356

setParallelism

setParallelism(parallelism: number): this
Parameters
- parallelism: number
Returns this
- Defined in builders/CommandStep.ts:216

setSkip

setSkip(skip: string | boolean): this
Parameters
- skip: string | boolean
Returns this
Implementation of SkipBuilder.setSkip
- Defined in builders/CommandStep.ts:171

setSoftFail

setSoftFail(fail: boolean): this
Parameters
- fail: boolean
Returns this
- Defined in builders/CommandStep.ts:315

setTimeout

setTimeout(minutes: number): this
Parameters
- minutes: number
Returns this
- Defined in builders/CommandStep.ts:331

skip

skip(skip: string | boolean): this
Parameters
- skip: string | boolean
Returns this
Deprecated
Use .setSkip() instead
Implementation of SkipBuilder.skip
- Defined in builders/CommandStep.ts:167

softFail

softFail(fail?: boolean): this
Parameters
- fail: boolean = true
Returns this
Deprecated
Use .setSoftFail() instead
- Defined in builders/CommandStep.ts:311

timeout

timeout(minutes: number): this
Parameters
- minutes: number
Returns this
Deprecated
Use .setTimeout() instead
- Defined in builders/CommandStep.ts:327

Class CommandStep

Implements

Index

Constructors

Methods

Constructors

constructor

Returns CommandStep

Methods

addAgent

Parameters

Returns this

addAutomaticRetry

Parameters

Returns this

addBranch

Parameters

Returns this

addCommand

Parameters

Returns this

addDependency

Parameters

Returns this

addEnv

Parameters

Returns this

addPlugin

Parameters

Returns this

addPlugins

Parameters

Returns this

agent

Parameters

Returns this

Deprecated

allowDependencyFailure

Parameters

Returns this

Deprecated

branch

Parameters

Returns this

Deprecated

build

Returns Promise<CommandStepSchema>

command

Parameters

Returns this

Deprecated

concurrency

Parameters

Returns this

Deprecated

condition

Parameters

Returns this

Deprecated

dependOn

Parameters

Returns this

Deprecated

env

Parameters

Returns this

Deprecated

getAgents

Returns Readonly<Record<string, string>>

getAutomaticRetries

Returns AutomaticRetry[]

getBranches

Returns readonly string[]

getCommands

Returns Iterable<string>

getConcurrency

Returns number | undefined

See

getConcurrencyGroup

Returns string | undefined

Returns
| boolean
| { allowed?: boolean; permit_on_passed?: boolean; reason?: string }
| undefined

`Optional`allowed?: boolean

`Optional`permit_on_passed?: boolean

`Optional`reason?: string