Interface CommandStepSchema

interface CommandStepSchema {
    agents?: AgentsObject | AgentsList;
    allow_dependency_failure?: boolean;
    artifact_paths?: string | string[];
    branches?: string | string[];
    cancel_on_build_failing?: boolean;
    command?: string | string[];
    commands?: string | string[];
    concurrency?: number;
    concurrency_group?: string;
    concurrency_method?: "ordered" | "eager";
    depends_on?:
        | string
        | (string | { allow_failure?: boolean; step?: string })[]
        | null;
    env?: Env;
    id?: string;
    identifier?: string;
    if?: string;
    key?: string;
    label?: string;
    matrix?:
        | (string | number | boolean)[]
        | {
            adjustments?: {
                skip?: string | boolean;
                soft_fail?:
                    | boolean
                    | { exit_status?: number
                    | "*"; [k: string]: unknown }[];
                with: (string | number | boolean)[] | { [k: string]: string };
                [k: string]: unknown;
            }[];
            setup: | { [k: string]: (string | number | boolean)[] }
            | (string | number | boolean)[];
            [k: string]: unknown;
        };
    name?: string;
    notify?: (
        | "github_check"
        | "github_commit_status"
        | { basecamp_campfire?: string; if?: string }
        | {
            if?: string;
            slack?:
                | string
                | { channels?: string[]; message?: string; [k: string]: unknown };
        }
        | {
            github_commit_status?: { context?: string; [k: string]: unknown };
            if?: string;
        }
        | {
            github_check?: { context?: string; [k: string]: unknown };
            if?: string;
        }
    )[];
    parallelism?: number;
    plugins?: { [k: string]: unknown }
    | (string | { [k: string]: unknown })[];
    priority?: number;
    retry?: {
        automatic?: boolean | AutomaticRetry | AutomaticRetry[];
        manual?:
            | boolean
            | { allowed?: boolean; permit_on_passed?: boolean; reason?: string };
        [k: string]: unknown;
    };
    skip?: string
    | boolean;
    soft_fail?:
        | boolean
        | { exit_status?: number
        | "*"; [k: string]: unknown }[];
    timeout_in_minutes?: number;
    type?: "script" | "command" | "commands";
}

Properties

`Optional`agents

agents?: AgentsObject | AgentsList

`Optional`allow_dependency_failure

allow_dependency_failure?: boolean

Whether to proceed with this step and further steps if a step named in the depends_on attribute fails

`Optional`artifact_paths

artifact_paths?: string | string[]

The glob path/s of artifacts to upload once this step has finished running

`Optional`branches

branches?: string | string[]

Which branches will include this step in their builds

`Optional`cancel_on_build_failing

cancel_on_build_failing?: boolean

Whether to cancel the job as soon as the build is marked as failing

`Optional`command

command?: string | string[]

The commands to run on the agent

`Optional`commands

commands?: string | string[]

The commands to run on the agent

`Optional`concurrency

concurrency?: number

The maximum number of jobs created from this step that are allowed to run at the same time. If you use this attribute, you must also define concurrency_group.

`Optional`concurrency_group

concurrency_group?: string

A unique name for the concurrency group that you are creating with the concurrency attribute

`Optional`concurrency_method

concurrency_method?: "ordered" | "eager"

Control command order, allowed values are 'ordered' (default) and 'eager'. If you use this attribute, you must also define concurrency_group and concurrency.

`Optional`depends_on

depends_on?:
    | string
    | (string | { allow_failure?: boolean; step?: string })[]
    | null

The step keys for a step to depend on

`Optional`env

env?: Env

`Optional`id

id?: string

A string identifier

`Optional`identifier

identifier?: string

A string identifier

`Optional`if

if?: string

A boolean expression that omits the step when false

`Optional`key

key?: string

A unique identifier for a step, must not resemble a UUID

`Optional`label

label?: string

The label that will be displayed in the pipeline visualisation in Buildkite. Supports emoji.

`Optional`matrix

matrix?:
    | (string | number | boolean)[]
    | {
        adjustments?: {
            skip?: string | boolean;
            soft_fail?:
                | boolean
                | { exit_status?: number
                | "*"; [k: string]: unknown }[];
            with: (string | number | boolean)[] | { [k: string]: string };
            [k: string]: unknown;
        }[];
        setup: | { [k: string]: (string | number | boolean)[] }
        | (string | number | boolean)[];
        [k: string]: unknown;
    }

Type Declaration

(string | number | boolean)[]
{
    adjustments?: {
        skip?: string | boolean;
        soft_fail?:
            | boolean
            | { exit_status?: number
            | "*"; [k: string]: unknown }[];
        with: (string | number | boolean)[] | { [k: string]: string };
        [k: string]: unknown;
    }[];
    setup: | { [k: string]: (string | number | boolean)[] }
    | (string | number | boolean)[];
    [k: string]: unknown;
}
- [k: string]: unknown
- Optionaladjustments?: {
      skip?: string | boolean;
      soft_fail?:
          | boolean
          | { exit_status?: number
          | "*"; [k: string]: unknown }[];
      with: (string | number | boolean)[] | { [k: string]: string };
      [k: string]: unknown;
  }[]
  List of Build Matrix adjustments
- setup: { [k: string]: (string | number | boolean)[] } | (string | number | boolean)[]

`Optional`name

name?: string

The label that will be displayed in the pipeline visualisation in Buildkite. Supports emoji.

`Optional`notify

notify?: (
    | "github_check"
    | "github_commit_status"
    | { basecamp_campfire?: string; if?: string }
    | {
        if?: string;
        slack?:
            | string
            | { channels?: string[]; message?: string; [k: string]: unknown };
    }
    | {
        github_commit_status?: { context?: string; [k: string]: unknown };
        if?: string;
    }
    | {
        github_check?: { context?: string; [k: string]: unknown };
        if?: string;
    }
)[]

Array of notification options for this step

Type Declaration

"github_check"
"github_commit_status"
{ basecamp_campfire?: string; if?: string }
- Optionalbasecamp_campfire?: string
- Optionalif?: string
  A boolean expression that omits the step when false
{
    if?: string;
    slack?:
        | string
        | { channels?: string[]; message?: string; [k: string]: unknown };
}
- Optionalif?: string
  A boolean expression that omits the step when false
- Optionalslack?: string | { channels?: string[]; message?: string; [k: string]: unknown }
{
github_commit_status?: { context?: string; [k: string]: unknown };
if?: string;
}
- Optionalgithub_commit_status?: { context?: string; [k: string]: unknown }
  - Optionalcontext?: string
    GitHub commit status name
- Optionalif?: string
  A boolean expression that omits the step when false
{ github_check?: { context?: string; [k: string]: unknown }; if?: string }
- Optionalgithub_check?: { context?: string; [k: string]: unknown }
  - Optionalcontext?: string
    GitHub commit status name
- Optionalif?: string
  A boolean expression that omits the step when false

`Optional`parallelism

parallelism?: number

The number of parallel jobs that will be created based on this step

`Optional`plugins

plugins?: { [k: string]: unknown } | (string | { [k: string]: unknown })[]

`Optional`priority

priority?: number

Priority of the job, higher priorities are assigned to agents

`Optional`retry

retry?: {
    automatic?: boolean | AutomaticRetry | AutomaticRetry[];
    manual?:
        | boolean
        | { allowed?: boolean; permit_on_passed?: boolean; reason?: string };
    [k: string]: unknown;
}

The conditions for retrying this step.

Type Declaration

[k: string]: unknown
Optionalautomatic?: boolean | AutomaticRetry | AutomaticRetry[]
Whether to allow a job to retry automatically. If set to true, the retry conditions are set to the default value.
Optionalmanual?: boolean | { allowed?: boolean; permit_on_passed?: boolean; reason?: string }
Whether to allow a job to be retried manually

`Optional`skip

skip?: string | boolean

Whether this step should be skipped. You can specify a reason for using a string.

`Optional`soft_fail

soft_fail?: boolean | { exit_status?: number | "*"; [k: string]: unknown }[]

The conditions for marking the step as a soft-fail.

Type Declaration

boolean
{ exit_status?: number | "*"; [k: string]: unknown }[]
- [k: string]: unknown
- Optionalexit_status?: number | "*"
  The exit status number that will cause this job to soft-fail

`Optional`timeout_in_minutes

timeout_in_minutes?: number

The number of minutes to time out a job

`Optional`type

type?: "script" | "command" | "commands"

Interface CommandStepSchema

Index

Properties

Properties

Optionalagents

Optionalallow_dependency_failure

Optionalartifact_paths

Optionalbranches

Optionalcancel_on_build_failing

Optionalcommand

Optionalcommands

Optionalconcurrency

Optionalconcurrency_group

Optionalconcurrency_method

Optionaldepends_on

Optionalenv

Optionalid

Optionalidentifier

Optionalif

Optionalkey

Optionallabel

Optionalmatrix

Type Declaration

[k: string]: unknown

Optionaladjustments?: { skip?: string | boolean; soft_fail?: | boolean | { exit_status?: number | "*"; [k: string]: unknown }[]; with: (string | number | boolean)[] | { [k: string]: string }; [k: string]: unknown;}[]

setup: { [k: string]: (string | number | boolean)[] } | (string | number | boolean)[]

Optionalname

Optionalnotify

Type Declaration

Optionalbasecamp_campfire?: string

Optionalif?: string

Optionalif?: string

Optionalslack?: string | { channels?: string[]; message?: string; [k: string]: unknown }

Optionalgithub_commit_status?: { context?: string; [k: string]: unknown }

Optionalcontext?: string

Optionalif?: string

Optionalgithub_check?: { context?: string; [k: string]: unknown }

Optionalcontext?: string

Optionalif?: string

Optionalparallelism

Optionalplugins

Optionalpriority

Optionalretry

Type Declaration

[k: string]: unknown

Optionalautomatic?: boolean | AutomaticRetry | AutomaticRetry[]

Optionalmanual?: boolean | { allowed?: boolean; permit_on_passed?: boolean; reason?: string }

Optionalskip

Optionalsoft_fail

Type Declaration

[k: string]: unknown

Optionalexit_status?: number | "*"

Optionaltimeout_in_minutes

Optionaltype

Settings

On This Page

`Optional`agents

`Optional`allow_dependency_failure

`Optional`artifact_paths

`Optional`branches

`Optional`cancel_on_build_failing

`Optional`command

`Optional`commands

`Optional`concurrency

`Optional`concurrency_group

`Optional`concurrency_method

`Optional`depends_on

`Optional`env

`Optional`id

`Optional`identifier

`Optional`if

`Optional`key

`Optional`label

`Optional`matrix

`Optional`adjustments?: {
skip?: string | boolean;
soft_fail?:
| boolean
| { exit_status?: number
| "*"; [k: string]: unknown }[];
with: (string | number | boolean)[] | { [k: string]: string };
[k: string]: unknown;
}[]

`Optional`name

`Optional`notify

`Optional`basecamp_campfire?: string

`Optional`if?: string

`Optional`if?: string

`Optional`slack?: string | { channels?: string[]; message?: string; [k: string]: unknown }

`Optional`github_commit_status?: { context?: string; [k: string]: unknown }

`Optional`context?: string

`Optional`if?: string

`Optional`github_check?: { context?: string; [k: string]: unknown }

`Optional`context?: string

`Optional`if?: string

`Optional`parallelism

`Optional`plugins

`Optional`priority

`Optional`retry

`Optional`automatic?: boolean | AutomaticRetry | AutomaticRetry[]

`Optional`manual?: boolean | { allowed?: boolean; permit_on_passed?: boolean; reason?: string }

`Optional`skip

`Optional`soft_fail

`Optional`exit_status?: number | "*"

`Optional`timeout_in_minutes

`Optional`type