BuildSpecBuilder

@cosmos-building-blocks/pipeline › Globals › BuildSpecBuilder

Hierarchy

• BuildSpec

  ↳ BuildSpecBuilder

Index

Constructors

• constructor

Properties

• isImmediate
• spec

Methods

• addCachePaths
• addCommands
• addEnvironmentVariables
• addExportedVariables
• addFinallyCommands
• addReports
• addRuntime
• addSecondaryArtifacts
• edit
• setArtifact
• toBuildSpec

Constructors

constructor

+ new BuildSpecBuilder(): BuildSpecBuilder

Overrides void

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:63

Returns: BuildSpecBuilder

Properties

Readonly isImmediate

• isImmediate: boolean

Overrides void

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:62

---

spec

• spec: BuildSpecObject

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:63

Methods

addCachePaths

▸ addCachePaths(...path: string[]): BuildSpecBuilder

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:140

Parameters:

Name	Type
...path	string[]

Returns: BuildSpecBuilder

---

addCommands

▸ addCommands(phase: Phase, ...commands: NullableString[]): BuildSpecBuilder

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:88

Parameters:

Name	Type
phase	Phase
...commands	NullableString[]

Returns: BuildSpecBuilder

---

addEnvironmentVariables

▸ addEnvironmentVariables(type: EnvironmentVariables, env: Record‹string, string›): BuildSpecBuilder

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:105

Parameters:

Name	Type
type	EnvironmentVariables
env	Record‹string, string›

Returns: BuildSpecBuilder

---

addExportedVariables

▸ addExportedVariables(...name: NullableString[]): BuildSpecBuilder

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:112

Parameters:

Name	Type
...name	NullableString[]

Returns: BuildSpecBuilder

---

addFinallyCommands

▸ addFinallyCommands(phase: Phase, ...commands: NullableString[]): BuildSpecBuilder

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:96

Parameters:

Name	Type
phase	Phase
...commands	NullableString[]

Returns: BuildSpecBuilder

---

addReports

▸ addReports(...report: Report[]): BuildSpecBuilder

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:133

Parameters:

Name	Type
...report	Report[]

Returns: BuildSpecBuilder

---

addRuntime

▸ addRuntime(runtime: Runtime, version: Version): BuildSpecBuilder

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:79

Parameters:

Name	Type
runtime	Runtime
version	Version

Returns: BuildSpecBuilder

---

addSecondaryArtifacts

▸ addSecondaryArtifacts(...artifact: Artifact[]): BuildSpecBuilder

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:125

Parameters:

Name	Type
...artifact	Artifact[]

Returns: BuildSpecBuilder

---

edit

▸ edit(fn: function): BuildSpecBuilder

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:147

Parameters:

▪ fn: function

▸ (spec: BuildSpecObject): BuildSpecObject | undefined

Parameters:

Name	Type
spec	BuildSpecObject

Returns: BuildSpecBuilder

---

setArtifact

▸ setArtifact(artifact: Artifact): BuildSpecBuilder

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:119

Parameters:

Name	Type
artifact	Artifact

Returns: BuildSpecBuilder

---

toBuildSpec

▸ toBuildSpec(): string

Overrides void

Defined in packages/@cosmos-building-blocks/pipeline/src/build-spec.ts:75

Returns: string