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

    Class TriggerStep

    Implements

    • KeyBuilder
    • StepBuilder
    • LabelBuilder
    • BranchFilterBuilder
    • ConditionBuilder
    • DependenciesBuilder
    • SkipBuilder
    Index

    Constructors

    constructor

    Methods

    addBranch addDependency allowDependencyFailure branch build condition dependOn getBranches getCondition getDependencies getKey getLabel key label setAllowDependencyFailure setAsync setBuild setCondition setKey setLabel setPipeline setSkip setSoftFail skip

    Constructors

    Methods

    • Parameters

      • branch: string

      Returns this

    • Parameters

      • dependency: string | { allow_failure?: boolean; step?: string }

      Returns this

    • Parameters

      • allow: boolean

      Returns this

      Use .setAllowDependencyFailure() instead

    • Parameters

      • branch: string

      Returns this

      Use .addBranch() instead

    • Parameters

      • condition: string

      Returns this

      Use .setCondition() instead

    • Parameters

      • dependency: string | { allow_failure?: boolean; step?: string }

      Returns this

      Use .addDependency() instead

    • Returns readonly string[]

    • Returns string | undefined

    • Returns readonly (string | { allow_failure?: boolean; step?: string })[]

    • Returns string | undefined

    • Parameters

      • key: string

      Returns this

      Use .setKey() instead

    • Parameters

      • label: string

      Returns this

      Use .setLabel() instead

    • Parameters

      • allow: boolean

      Returns this

    • Parameters

      • build:
            | {
                branch?: string;
                commit?: string;
                env?: Env;
                label?: string;
                message?: string;
                meta_data?: { [k: string]: unknown };
                name?: string;
                trigger?: string;
                type?: "trigger";
            }
            | undefined
        • {
              branch?: string;
              commit?: string;
              env?: Env;
              label?: string;
              message?: string;
              meta_data?: { [k: string]: unknown };
              name?: string;
              trigger?: string;
              type?: "trigger";
          }
          • 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"
        • undefined

      Returns this

    • Parameters

      • condition: string

      Returns this

    • Parameters

      • key: string

      Returns this

    • Parameters

      • label: string

      Returns this

    • Parameters

      • skip: string | boolean

      Returns this

    • Parameters

      • skip: string | boolean

      Returns this

      Use .setSkip() instead

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods