Class Pipeline

Implements

PipelineBuilder
AgentsBuilder
NotifyBuilder
StepsBuilder
EnvironmentBuilder

Index

Constructors

constructor

Methods

addAgent addEnv addNotification addStep addSteps agent build getAgents getEnv getSteps notify step steps

Constructors

constructor

new Pipeline(): Pipeline
Returns Pipeline

Methods

addAgent

addAgent(tag: string, value: string): this
Parameters
- tag: string
- value: string
Returns this
See
https://buildkite.com/docs/agent/v3/cli-start#agent-targeting
Implementation of AgentsBuilder.addAgent
- Defined in builders/Pipeline.ts:36

addEnv

addEnv(name: string, value: unknown): this
Parameters
- name: string
- value: unknown
Returns this
Implementation of EnvironmentBuilder.addEnv
- Defined in builders/Pipeline.ts:45

addNotification

addNotification(
    notification:
        | "github_check"
        | "github_commit_status"
        | { email?: string; if?: string }
        | { basecamp_campfire?: string; if?: string }
        | {
            if?: string;
            slack?:
                | string
                | { channels?: string[]; message?: string; [k: string]: unknown };
        }
        | { if?: string; webhook?: string }
        | { if?: string; pagerduty_change_event?: string }
        | {
            github_commit_status?: { context?: string; [k: string]: unknown };
            if?: string;
        }
        | {
            github_check?: { context?: string; [k: string]: unknown };
            if?: string;
        },
): this
Parameters
- notification:
      | "github_check"
      | "github_commit_status"
      | { email?: string; if?: string }
      | { basecamp_campfire?: string; if?: string }
      | {
          if?: string;
          slack?:
              | string
              | { channels?: string[]; message?: string; [k: string]: unknown };
      }
      | { if?: string; webhook?: string }
      | { if?: string; pagerduty_change_event?: string }
      | {
          github_commit_status?: { context?: string; [k: string]: unknown };
          if?: string;
      }
      | {
          github_check?: { context?: string; [k: string]: unknown };
          if?: string;
      }
  - "github_check"
  - "github_commit_status"
  - { email?: string; if?: string }
    Optionalemail?: string
    Optionalif?: string
    A boolean expression that omits the step when false
  - { basecamp_campfire?: string; if?: string }
    Optionalbasecamp_campfire?: string
    Optionalif?: string
    A boolean expression that omits the step when false
  - {
        if?: string;
        slack?:
            | string
            | { channels?: string[]; message?: string; [k: string]: unknown };
    }
    Optionalif?: string
    A boolean expression that omits the step when false
    
    Optionalslack?: string | { channels?: string[]; message?: string; [k: string]: unknown }
  - { if?: string; webhook?: string }
    Optionalif?: string
    A boolean expression that omits the step when false
    
    Optionalwebhook?: string
  - { if?: string; pagerduty_change_event?: string }
    Optionalif?: string
    A boolean expression that omits the step when false
    
    Optionalpagerduty_change_event?: string
  - {
    github_commit_status?: { context?: string; [k: string]: unknown };
    if?: string;
    }
    Optionalgithub_commit_status?: { context?: string; [k: string]: unknown }
    Optionalcontext?: string
    GitHub commit status name
    
    Optionalif?: string
    A boolean expression that omits the step when false
  - { github_check?: { context?: string; [k: string]: unknown }; if?: string }
    Optionalgithub_check?: { context?: string; [k: string]: unknown }
    Optionalcontext?: string
    GitHub commit status name
    
    Optionalif?: string
    A boolean expression that omits the step when false
Returns this
See
https://buildkite.com/docs/pipelines/notifications
Implementation of NotifyBuilder.addNotification
- Defined in builders/Pipeline.ts:60

addStep

addStep(step: StepSchema | StepBuilder): this
Parameters
- step: StepSchema | StepBuilder
Returns this
Implementation of StepsBuilder.addStep
- Defined in builders/Pipeline.ts:77

addSteps

addSteps(steps: Iterable<StepSchema | StepBuilder>): this
Parameters
- steps: Iterable<StepSchema | StepBuilder>
Returns this
Implementation of StepsBuilder.addSteps
- Defined in builders/Pipeline.ts:90

agent

agent(tag: string, value: string): this
Parameters
- tag: string
- value: string
Returns this
Deprecated
Use .addAgent() instead
Implementation of AgentsBuilder.agent
- Defined in builders/Pipeline.ts:29

build

build(): Promise<JSONSchemaForBuildkitePipelineConfigurationFiles>
Returns Promise<JSONSchemaForBuildkitePipelineConfigurationFiles>
Implementation of PipelineBuilder.build
- Defined in builders/Pipeline.ts:95

getAgents

getAgents(): Readonly<Record<string, string>>
Returns Readonly<Record<string, string>>
Implementation of AgentsBuilder.getAgents
- Defined in builders/Pipeline.ts:22

getEnv

getEnv(): Readonly<Record<string, unknown>>
Returns Readonly<Record<string, unknown>>
Implementation of EnvironmentBuilder.getEnv
- Defined in builders/Pipeline.ts:41

getSteps

getSteps(): readonly (StepSchema | StepBuilder)[]
Returns readonly (StepSchema | StepBuilder)[]
Implementation of StepsBuilder.getSteps
- Defined in builders/Pipeline.ts:65

notify

notify(
    notification:
        | "github_check"
        | "github_commit_status"
        | { email?: string; if?: string }
        | { basecamp_campfire?: string; if?: string }
        | {
            if?: string;
            slack?:
                | string
                | { channels?: string[]; message?: string; [k: string]: unknown };
        }
        | { if?: string; webhook?: string }
        | { if?: string; pagerduty_change_event?: string }
        | {
            github_commit_status?: { context?: string; [k: string]: unknown };
            if?: string;
        }
        | {
            github_check?: { context?: string; [k: string]: unknown };
            if?: string;
        },
): this
Parameters
- notification:
      | "github_check"
      | "github_commit_status"
      | { email?: string; if?: string }
      | { basecamp_campfire?: string; if?: string }
      | {
          if?: string;
          slack?:
              | string
              | { channels?: string[]; message?: string; [k: string]: unknown };
      }
      | { if?: string; webhook?: string }
      | { if?: string; pagerduty_change_event?: string }
      | {
          github_commit_status?: { context?: string; [k: string]: unknown };
          if?: string;
      }
      | {
          github_check?: { context?: string; [k: string]: unknown };
          if?: string;
      }
  - "github_check"
  - "github_commit_status"
  - { email?: string; if?: string }
    Optionalemail?: string
    Optionalif?: string
    A boolean expression that omits the step when false
  - { basecamp_campfire?: string; if?: string }
    Optionalbasecamp_campfire?: string
    Optionalif?: string
    A boolean expression that omits the step when false
  - {
        if?: string;
        slack?:
            | string
            | { channels?: string[]; message?: string; [k: string]: unknown };
    }
    Optionalif?: string
    A boolean expression that omits the step when false
    
    Optionalslack?: string | { channels?: string[]; message?: string; [k: string]: unknown }
  - { if?: string; webhook?: string }
    Optionalif?: string
    A boolean expression that omits the step when false
    
    Optionalwebhook?: string
  - { if?: string; pagerduty_change_event?: string }
    Optionalif?: string
    A boolean expression that omits the step when false
    
    Optionalpagerduty_change_event?: string
  - {
    github_commit_status?: { context?: string; [k: string]: unknown };
    if?: string;
    }
    Optionalgithub_commit_status?: { context?: string; [k: string]: unknown }
    Optionalcontext?: string
    GitHub commit status name
    
    Optionalif?: string
    A boolean expression that omits the step when false
  - { github_check?: { context?: string; [k: string]: unknown }; if?: string }
    Optionalgithub_check?: { context?: string; [k: string]: unknown }
    Optionalcontext?: string
    GitHub commit status name
    
    Optionalif?: string
    A boolean expression that omits the step when false
Returns this
Deprecated
Use .addNotification() instead
Implementation of NotifyBuilder.notify
- Defined in builders/Pipeline.ts:53

step

step(step: StepSchema | StepBuilder): this
Parameters
- step: StepSchema | StepBuilder
Returns this
Deprecated
Use .addStep() instead
Implementation of StepsBuilder.step
- Defined in builders/Pipeline.ts:72

steps

steps(steps: Iterable<StepSchema | StepBuilder>): this
Parameters
- steps: Iterable<StepSchema | StepBuilder>
Returns this
Deprecated
Use .addSteps() instead
Implementation of StepsBuilder.steps
- Defined in builders/Pipeline.ts:85

Class Pipeline

Implements

Index

Constructors

Methods

Constructors

constructor

Returns Pipeline

Methods

addAgent

Parameters

Returns this

See

addEnv

Parameters

Returns this

addNotification

Parameters

Optionalemail?: string

Optionalif?: string

Optionalbasecamp_campfire?: string

Optionalif?: string

Optionalif?: string

Optionalslack?: string | { channels?: string[]; message?: string; [k: string]: unknown }

Optionalif?: string

Optionalwebhook?: string

Optionalif?: string

Optionalpagerduty_change_event?: string

Optionalgithub_commit_status?: { context?: string; [k: string]: unknown }

Optionalcontext?: string

Optionalif?: string

Optionalgithub_check?: { context?: string; [k: string]: unknown }

Optionalcontext?: string

Optionalif?: string

Returns this

See

addStep

Parameters

Returns this

addSteps

Parameters

Returns this

agent

Parameters

Returns this

Deprecated

build

Returns Promise<JSONSchemaForBuildkitePipelineConfigurationFiles>

getAgents

Returns Readonly<Record<string, string>>

getEnv

Returns Readonly<Record<string, unknown>>

getSteps

Returns readonly (StepSchema | StepBuilder)[]

notify

Parameters

Optionalemail?: string

Optionalif?: string

Optionalbasecamp_campfire?: string

Optionalif?: string

Optionalif?: string

Optionalslack?: string | { channels?: string[]; message?: string; [k: string]: unknown }

Optionalif?: string

Optionalwebhook?: string

Optionalif?: string

Optionalpagerduty_change_event?: string

Optionalgithub_commit_status?: { context?: string; [k: string]: unknown }

Optionalcontext?: string

Optionalif?: string

Optionalgithub_check?: { context?: string; [k: string]: unknown }

Optionalcontext?: string

Optionalif?: string

Returns this

Deprecated

step

Parameters

Returns this

Deprecated

steps

Parameters

`Optional`email?: string

`Optional`if?: string

`Optional`basecamp_campfire?: string

`Optional`if?: string

`Optional`if?: string

`Optional`slack?: string | { channels?: string[]; message?: string; [k: string]: unknown }

`Optional`if?: string

`Optional`webhook?: string

`Optional`if?: string

`Optional`pagerduty_change_event?: string

`Optional`github_commit_status?: { context?: string; [k: string]: unknown }

`Optional`context?: string

`Optional`if?: string

`Optional`github_check?: { context?: string; [k: string]: unknown }

`Optional`context?: string

`Optional`if?: string

`Optional`email?: string

`Optional`if?: string

`Optional`basecamp_campfire?: string

`Optional`if?: string

`Optional`if?: string

`Optional`slack?: string | { channels?: string[]; message?: string; [k: string]: unknown }

`Optional`if?: string

`Optional`webhook?: string

`Optional`if?: string

`Optional`pagerduty_change_event?: string

`Optional`github_commit_status?: { context?: string; [k: string]: unknown }

`Optional`context?: string

`Optional`if?: string

`Optional`github_check?: { context?: string; [k: string]: unknown }

`Optional`context?: string

`Optional`if?: string