@buildkite/buildkite-sdk
    Preparing search index...

    Interface CommandStep

    interface CommandStep {
        agents?: Agents;
        allow_dependency_failure?: AllowDependencyFailure;
        artifact_paths?: string | string[];
        branches?: Branches;
        cache?: Cache;
        cancel_on_build_failing?: CancelOnBuildFailing;
        command?: CommandStepCommand;
        commands?: CommandStepCommand;
        concurrency?: number;
        concurrency_group?: string;
        concurrency_method?: "ordered" | "eager";
        depends_on?: DependsOn;
        env?: Env;
        id?: string;
        identifier?: string;
        if?: string;
        if_changed?: IfChanged;
        image?: string;
        key?: string;
        label?: string;
        matrix?: Matrix;
        name?: string;
        notify?: CommandStepNotify;
        parallelism?: number;
        plugins?: Plugins;
        priority?: number;
        retry?: {
            automatic?: CommandStepAutomaticRetry;
            manual?: CommandStepManualRetry;
        };
        secrets?: Secrets;
        signature?: {
            algorithm?: string;
            signed_fields?: string[];
            value?: string;
        };
        skip?: Skip;
        soft_fail?: SoftFail;
        timeout_in_minutes?: number;
        type?: "script"
        | "command"
        | "commands";
    }
    Index

    Properties

    agents? allow_dependency_failure? artifact_paths? branches? cache? cancel_on_build_failing? command? commands? concurrency? concurrency_group? concurrency_method? depends_on? env? id? identifier? if? if_changed? image? key? label? matrix? name? notify? parallelism? plugins? priority? retry? secrets? signature? skip? soft_fail? timeout_in_minutes? type?

    Properties

    agents?: Agents
    allow_dependency_failure?: AllowDependencyFailure

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

    artifact_paths?: string | string[]

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

    branches?: Branches

    Which branches will include this step in their builds

    cache?: Cache

    The paths for the caches to be used in the step

    cancel_on_build_failing?: CancelOnBuildFailing

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

    command?: CommandStepCommand

    The commands to run on the agent

    commands?: CommandStepCommand

    The commands to run on the agent

    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.

    concurrency_group?: string

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

    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.

    depends_on?: DependsOn

    The step keys for a step to depend on

    env?: Env

    Environment variables for this step

    id?: string

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

    identifier?: string

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

    if?: string

    A boolean expression that omits the step when false

    if_changed?: IfChanged

    Agent-applied attribute: A glob pattern that omits the step from a build if it does not match any files changed in the build. Can be a single pattern, list of patterns, or an object with include/exclude attributes.

    image?: string

    (Kubernetes stack only) The container image to use for this pipeline or step

    key?: string

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

    label?: string

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

    matrix?: Matrix
    name?: string

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

    notify?: CommandStepNotify

    Array of notification options for this step

    parallelism?: number

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

    plugins?: Plugins
    priority?: number

    Priority of the job, higher priorities are assigned to agents

    retry?: {
        automatic?: CommandStepAutomaticRetry;
        manual?: CommandStepManualRetry;
    }

    The conditions for retrying this step.

    Type Declaration

    • Optionalautomatic?: CommandStepAutomaticRetry

      Whether to allow a job to retry automatically. If set to true, the retry conditions are set to the default value.

    • Optionalmanual?: CommandStepManualRetry

      Whether to allow a job to be retried manually

    secrets?: Secrets

    A list of secret names or a mapping of environment variable names to secret names to be made available to the build or step

    signature?: { algorithm?: string; signed_fields?: string[]; value?: string }

    The signature of the command step, generally injected by agents at pipeline upload

    Type Declaration

    • Optionalalgorithm?: string

      The algorithm used to generate the signature

    • Optionalsigned_fields?: string[]

      The fields that were signed to form the signature value

    • Optionalvalue?: string

      The signature value, a JWS compact signature with a detached body

    skip?: Skip

    Whether this step should be skipped. Passing a string provides a reason for skipping this command

    soft_fail?: SoftFail

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

    timeout_in_minutes?: number

    The number of minutes to time out a job

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

    Settings

    Member Visibility

    On This Page

    Properties