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

    Interface InputStep

    interface InputStep {
        allow_dependency_failure?: AllowDependencyFailure;
        allowed_teams?: AllowedTeams;
        blocked_state?: "passed" | "failed" | "running";
        branches?: Branches;
        depends_on?: DependsOn;
        fields?: Fields;
        id?: string;
        identifier?: string;
        if?: string;
        input?: string;
        key?: string;
        label?: string;
        name?: string;
        prompt?: string;
        type?: "input";
    }
    Index

    Properties

    allow_dependency_failure? allowed_teams? blocked_state? branches? depends_on? fields? id? identifier? if? input? key? label? name? prompt? type?

    Properties

    allow_dependency_failure?: AllowDependencyFailure

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

    allowed_teams?: AllowedTeams

    A list of teams that are permitted to unblock this step, whose values are a list of one or more team slugs or IDs

    blocked_state?: "passed" | "failed" | "running"

    The state that the build is set to when the build is blocked by this input step

    branches?: Branches

    Which branches will include this step in their builds

    depends_on?: DependsOn

    The step keys for a step to depend on

    fields?: Fields

    A list of input fields required to be filled out before unblocking the 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

    input?: string

    The label of the input step

    key?: string

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

    label?: string

    The label of the input step

    name?: string

    The label of the input step

    prompt?: string

    The instructional message displayed in the dialog box when the unblock step is activated

    type?: "input"

    Settings

    Member Visibility

    On This Page

    Properties