cli/foundry.cli.buildkite

Package-level declarations

Types

Adjustment

@Serializable

data class Adjustment(val skip: Skip? = null, val softFail: SoftFail? = null, val with: With)

An adjustment to a Build Matrix

Agents

@Serializable

sealed interface Agents

Automatic

@Serializable

sealed interface Automatic

Whether to allow a job to retry automatically. If set to true, the retry conditions are set to the default value.

AutomaticElement

@Serializable

data class AutomaticElement(val exitStatus: ExitStatusUnion? = null, val limit: Long? = null, val signal: String? = null, val signalReason: SignalReason? = null)

Block

@Serializable

sealed interface Block

BlockedState

@Serializable

enum BlockedState : Enum<BlockedState>

The state that the build is set to when the build is blocked by this block step

BlockStep

@Serializable

data class BlockStep(val allowDependencyFailure: Boolean? = null, val block: String? = null, val blockedState: BlockedState? = null, val branches: SimpleStringValue? = null, val dependsOn: DependsOn? = null, val fields: List<FieldElement>? = null, val id: String? = null, val identifier: String? = null, val blockStepIf: String? = null, val key: String? = null, val label: String? = null, val name: String? = null, val prompt: String? = null, val type: BlockType? = null) : Keyable

BlockType

@Serializable

enum BlockType : Enum<BlockType>

Build

@Serializable

data class Build(val branch: String? = null, val commit: String? = null, val env: JsonObject? = null, val label: String? = null, val message: String? = null, val metaData: JsonObject? = null, val name: String? = null, val trigger: String? = null, val type: BuildType? = null)

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

BuildType

@Serializable

enum BuildType : Enum<BuildType>

Commands

@Serializable

sealed interface Commands

CommandStep

@Serializable

data class CommandStep(val allowDependencyFailure: Boolean? = null, val block: String? = null, val blockedState: BlockedState? = null, val branches: SimpleStringValue? = null, val dependsOn: DependsOn? = null, val fields: List<FieldElement>? = null, val id: String? = null, val identifier: String? = null, val stepIf: String? = null, val key: String? = null, val label: String? = null, val name: String? = null, val prompt: String? = null, val type: StepType? = null, val agents: Agents? = null, val artifactPaths: SimpleStringValue? = null, val cancelOnBuildFailing: Boolean? = null, val command: Commands? = null, val commands: Commands? = null, val concurrency: Long? = null, val concurrencyGroup: String? = null, val concurrencyMethod: ConcurrencyMethod? = null, val env: Map<String, String>? = null, val matrix: MatrixUnion? = null, val notify: List<Notification>? = null, val parallelism: Long? = null, val plugins: Plugins? = null, val priority: Long? = null, val retry: Retry? = null, val signature: Signature? = null, val skip: Skip? = null, val softFail: SoftFail? = null, val timeoutInMinutes: Long? = null, val script: ScriptStep? = null, val async: Boolean? = null, val build: Build? = null, val trigger: Trigger? = null, val input: Input? = null, val continueOnFailure: Boolean? = null, val wait: Wait? = null, val waiter: Wait? = null) : Keyable

Waits for previous steps to pass before continuing

ConcurrencyMethod

@Serializable

enum ConcurrencyMethod : Enum<ConcurrencyMethod>

Control command order, allowed values are 'ordered' (default) and 'eager'. If you use this attribute, you must also define concurrency_group and concurrency.

Conditions

object Conditions

DependsOn

@Serializable

sealed interface DependsOn

The step keys for a step to depend on

DependsOnClass

@Serializable

data class DependsOnClass(val allowFailure: Boolean? = null, val step: String? = null)

DependsOnElement

@Serializable

sealed interface DependsOnElement

ExitStatusEnum

@Serializable

enum ExitStatusEnum : Enum<ExitStatusEnum>

ExitStatusUnion

@Serializable

sealed interface ExitStatusUnion

ExternalNotification

@Serializable

data class ExternalNotification(val email: String? = null, val notifyIf: String? = null, val basecampCampfire: String? = null, val slack: SlackNotification? = null, val webhook: String? = null, val pagerdutyChangeEvent: String? = null, val githubCommitStatus: GithubCommitStatus? = null, val githubCheck: GithubCheck? = null)

FieldElement

@Serializable

data class FieldElement(val default: SimpleStringValue? = null, val hint: String? = null, val key: String, val required: Boolean? = null, val text: String? = null, val multiple: Boolean? = null, val options: List<Option>? = null, val select: String? = null)

A list of input fields required to be filled out before unblocking the step

GithubCheck

@Serializable

data class GithubCheck(val context: String? = null)

GithubCommitStatus

@Serializable

data class GithubCommitStatus(val context: String? = null)

GithubNotification

@Serializable

enum GithubNotification : Enum<GithubNotification>

GroupStep

@Serializable

sealed interface GroupStep : Keyable

Input

@Serializable

sealed interface Input

InputStep

@Serializable

data class InputStep(val allowDependencyFailure: Boolean? = null, val branches: SimpleStringValue? = null, val dependsOn: DependsOn? = null, val fields: List<FieldElement>? = null, val id: String? = null, val identifier: String? = null, val inputStepIf: String? = null, val input: String? = null, val key: String? = null, val label: String? = null, val name: String? = null, val prompt: String? = null, val type: InputType? = null) : Keyable

InputType

@Serializable

enum InputType : Enum<InputType>

Keyable

interface Keyable

A buildkite element that can be identified with a key.

ManualClass

@Serializable

data class ManualClass(val allowed: Boolean? = null, val permitOnPassed: Boolean? = null, val reason: String? = null)

ManualUnion

@Serializable

sealed interface ManualUnion

Whether to allow a job to be retried manually

MatrixClass

@Serializable

data class MatrixClass(val adjustments: List<Adjustment>? = null, val setup: Setup)

Configuration for multi-dimension Build Matrix

MatrixElement

@Serializable

sealed interface MatrixElement

List of elements for simple single-dimension Build Matrix

MatrixUnion

@Serializable

sealed interface MatrixUnion

MultiChannelMessage

@Serializable

data class MultiChannelMessage(val channels: List<String>? = null, val message: String? = null)

NestedBlockStepClass

@Serializable

data class NestedBlockStepClass(val allowDependencyFailure: Boolean? = null, val block: Block? = null, val blockedState: BlockedState? = null, val branches: SimpleStringValue? = null, val dependsOn: DependsOn? = null, val fields: List<FieldElement>? = null, val id: String? = null, val identifier: String? = null, val stepIf: String? = null, val key: String? = null, val label: String? = null, val name: String? = null, val prompt: String? = null, val type: NestedBlockStepType? = null, val input: Input? = null, val agents: Agents? = null, val artifactPaths: SimpleStringValue? = null, val cancelOnBuildFailing: Boolean? = null, val command: Commands? = null, val commands: Commands? = null, val concurrency: Long? = null, val concurrencyGroup: String? = null, val concurrencyMethod: ConcurrencyMethod? = null, val env: JsonObject? = null, val matrix: MatrixUnion? = null, val notify: List<Notification>? = null, val parallelism: Long? = null, val plugins: Plugins? = null, val priority: Long? = null, val retry: Retry? = null, val signature: Signature? = null, val skip: Skip? = null, val softFail: SoftFail? = null, val timeoutInMinutes: Long? = null, val script: ScriptStep? = null, val continueOnFailure: Boolean? = null, val wait: Wait? = null, val waiter: Wait? = null, val async: Boolean? = null, val build: Build? = null, val trigger: Trigger? = null, val group: String? = null, val steps: List<Step>? = null) : Keyable

Waits for previous steps to pass before continuing

NestedBlockStepType

@Serializable

enum NestedBlockStepType : Enum<NestedBlockStepType>

Notification

@Serializable

sealed interface Notification

Array of notification options for this step

Option

@Serializable

data class Option(val hint: String? = null, val label: String, val required: Boolean? = null, val value: String)

Pipeline

@Serializable

data class Pipeline(val steps: List<GroupStep>, val agents: Agents? = null, val env: JsonObject? = null, val notify: List<Notification>? = null)

Plugin

@Serializable

sealed interface Plugin

Array of plugins for this step

Plugins

@Serializable

sealed interface Plugins

Retry

@Serializable

data class Retry(val automatic: Automatic? = null, val manual: ManualUnion? = null)

The conditions for retrying this step.

ScriptStep

@Serializable

data class ScriptStep(val agents: Agents? = null, val allowDependencyFailure: Boolean? = null, val artifactPaths: SimpleStringValue? = null, val branches: SimpleStringValue? = null, val cancelOnBuildFailing: Boolean? = null, val command: SimpleStringValue? = null, val commands: SimpleStringValue? = null, val concurrency: Long? = null, val concurrencyGroup: String? = null, val concurrencyMethod: ConcurrencyMethod? = null, val dependsOn: DependsOn? = null, val env: JsonObject? = null, val id: String? = null, val identifier: String? = null, val commandStepIf: String? = null, val key: String? = null, val label: String? = null, val matrix: MatrixUnion? = null, val name: String? = null, val notify: List<Notification>? = null, val parallelism: Long? = null, val plugins: Plugins? = null, val priority: Long? = null, val retry: Retry? = null, val signature: Signature? = null, val skip: Skip? = null, val softFail: SoftFail? = null, val timeoutInMinutes: Long? = null, val type: ScriptType? = null) : Keyable

ScriptType

@Serializable

enum ScriptType : Enum<ScriptType>

Setup

@Serializable

sealed interface Setup

SignalReason

@Serializable

enum SignalReason : Enum<SignalReason>

The exit signal reason, if any, that may be retried

Signature

@Serializable

data class Signature(val algorithm: String? = null, val signedFields: List<String>? = null, val value: String? = null)

The signature of the command step, generally injected by agents at pipeline upload

SimpleStringValue

@Serializable

sealed interface SimpleStringValue

Skip

@Serializable

sealed interface Skip

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

SlackNotification

@Serializable

sealed interface SlackNotification

SoftFail

@Serializable

sealed interface SoftFail

The conditions for marking the step as a soft-fail.

SoftFailElement

@Serializable

data class SoftFailElement(val exitStatus: ExitStatusUnion? = null)

Step

@Serializable

sealed interface Step : Keyable

StepType

@Serializable

enum StepType : Enum<StepType>

StringStep

@Serializable

enum StringStep : Enum<StringStep>

Pauses the execution of a build and waits on a user to unblock it

Trigger

@Serializable

sealed interface Trigger : Keyable

TriggerStep

@Serializable

data class TriggerStep(val allowDependencyFailure: Boolean? = null, val async: Boolean? = null, val branches: SimpleStringValue? = null, val build: Build? = null, val dependsOn: DependsOn? = null, val id: String? = null, val identifier: String? = null, val triggerStepIf: String? = null, val key: String? = null, val label: String? = null, val name: String? = null, val skip: Skip? = null, val softFail: SoftFail? = null, val trigger: String? = null, val type: BuildType? = null) : Keyable

Wait

@Serializable

sealed interface Wait : Keyable

WaitStep

@Serializable

data class WaitStep(val wait: String? = null, val allowDependencyFailure: Boolean? = null, val continueOnFailure: Boolean? = null, val dependsOn: DependsOn? = null, val id: String? = null, val identifier: String? = null, val waitStepIf: String? = null, val key: String? = null, val type: WaitType? = null, val waiter: String? = null) : Keyable

Waits for previous steps to pass before continuing

WaitType

@Serializable

enum WaitType : Enum<WaitType>

With

@Serializable

sealed interface With