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

    Interface TriggerStep

    interface TriggerStep {
        allow_dependency_failure?: AllowDependencyFailure;
        async?: boolean | "true" | "false";
        branches?: Branches;
        build?: {
            branch?: string;
            commit?: string;
            env?: Env;
            message?: string;
            meta_data?: Record<string, any>;
        };
        depends_on?: DependsOn;
        id?: string;
        identifier?: string;
        if?: string;
        if_changed?: IfChanged;
        key?: string;
        label?: string;
        name?: string;
        skip?: Skip;
        soft_fail?: SoftFail;
        trigger: string;
        type?: "trigger";
    }
    Index

    Properties

    allow_dependency_failure? async? branches? build? depends_on? id? identifier? if? if_changed? key? label? name? skip? soft_fail? trigger 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

    async?: boolean | "true" | "false"

    Whether to continue the build without waiting for the triggered step to complete

    branches?: Branches

    Which branches will include this step in their builds

    build?: {
        branch?: string;
        commit?: string;
        env?: Env;
        message?: string;
        meta_data?: Record<string, any>;
    }

    Properties of the build that will be created when the step is triggered

    Type Declaration

    • Optionalbranch?: string

      The branch for the build

    • Optionalcommit?: string

      The commit hash for the build

    • Optionalenv?: Env

      Environment variables for this step

    • Optionalmessage?: string

      The message for the build (supports emoji)

    • Optionalmeta_data?: Record<string, any>

      Meta-data for the build

    depends_on?: DependsOn

    The step keys for a step to depend on

    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.

    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.

    name?: string

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

    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.

    trigger: string

    The slug of the pipeline to create a build

    type?: "trigger"

    Settings

    Member Visibility

    On This Page

    Properties