Class Pipeline

constructor

• new Pipeline(): Pipeline

  Returns Pipeline

agents

env

notify

secrets

steps

addAgent

• addAgent(tagName: string, tagValue: string): void

  Add an agent to target by tag

  Parameters

  • tagName: string
  • tagValue: string

  Returns void

addEnvironmentVariable

• addEnvironmentVariable(key: string, value: any): void

  Add an environment variable

  Parameters

  • key: string
  • value: any

  Returns void

addNotify

• addNotify(
      notify:
          | NotifySimple
          | NotifyEmail
          | NotifyBasecamp
          | NotifySlack
          | NotifyWebhook
          | NotifyPagerduty
          | NotifyGithubCommitStatus
          | NotifyGithubCheck,
  ): void

  Add an notification

  Parameters

  • notify:
        | NotifySimple
        | NotifyEmail
        | NotifyBasecamp
        | NotifySlack
        | NotifyWebhook
        | NotifyPagerduty
        | NotifyGithubCommitStatus
        | NotifyGithubCheck

  Returns void

addStep

• addStep(
      step:
          | BlockStep
          | "block"
          | CommandStep
          | GroupStep
          | NestedBlockStep
          | InputStep
          | NestedInputStep
          | "input"
          | NestedCommandStep
          | WaitStep
          | NestedWaitStep
          | StringWaitStep
          | TriggerStep
          | NestedTriggerStep,
  ): Pipeline

  Add a step to the pipeline.

  Parameters

  • step:
        | BlockStep
        | "block"
        | CommandStep
        | GroupStep
        | NestedBlockStep
        | InputStep
        | NestedInputStep
        | "input"
        | NestedCommandStep
        | WaitStep
        | NestedWaitStep
        | StringWaitStep
        | TriggerStep
        | NestedTriggerStep

  Returns Pipeline

setPipeline

• setPipeline(pipeline: BuildkitePipeline): void

  Set the pipeline

  Parameters

  • pipeline: BuildkitePipeline

  Returns void

setSecrets

• setSecrets(secrets: Secrets): void

  Set the secrets for the pipeline

  Parameters

  • secrets: Secrets

  Returns void

toJSON

• toJSON(): string

  Returns string

toYAML

• toYAML(): string

  Returns string