@jameslnewell/buildkite-pipelines
    Preparing search index...

    Interface TriggerStepSchema

    interface TriggerStepSchema {
        allow_dependency_failure?: boolean;
        async?: boolean;
        branches?: string | string[];
        build?: {
            branch?: string;
            commit?: string;
            env?: Env;
            label?: string;
            message?: string;
            meta_data?: { [k: string]: unknown };
            name?: string;
            trigger?: string;
            type?: "trigger";
        };
        depends_on?: | string
        | (string | { allow_failure?: boolean; step?: string })[]
        | null;
        id?: string;
        identifier?: string;
        if?: string;
        key?: string;
        label?: string;
        name?: string;
        skip?: string | boolean;
        soft_fail?:
            | boolean
            | { exit_status?: number
            | "*"; [k: string]: unknown }[];
        trigger?: string;
        type?: "trigger";
    }
    Index

    Properties

    allow_dependency_failure? async? branches? build? depends_on? id? identifier? if? key? label? name? skip? soft_fail? trigger? type?

    Properties

    allow_dependency_failure?: boolean

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

    async?: boolean

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

    branches?: string | string[]

    Which branches will include this step in their builds

    build?: {
        branch?: string;
        commit?: string;
        env?: Env;
        label?: string;
        message?: string;
        meta_data?: { [k: string]: unknown };
        name?: string;
        trigger?: string;
        type?: "trigger";
    }

    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
    • Optionallabel?: string

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

    • Optionalmessage?: string

      The message for the build (supports emoji)

    • Optionalmeta_data?: { [k: string]: unknown }

      Meta-data for the build

    • Optionalname?: string

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

    • Optionaltrigger?: string

      The slug of the pipeline to create a build

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

    The step keys for a step to depend on

    id?: string

    A string identifier

    identifier?: string

    A string identifier

    if?: string

    A boolean expression that omits the step when false

    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?: string | boolean

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

    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

    trigger?: string

    The slug of the pipeline to create a build

    type?: "trigger"

    Settings

    Member Visibility

    On This Page

    Properties