@decentm/concourse-ts / SetPipelineStep

Defined in: components/step/set-pipeline.ts:15

Configures a pipeline from within a pipeline. Useful for creating self-updating pipelines or dynamically generating pipelines based on build artifacts.

https://concourse-ci.org/docs/steps/set-pipeline/

• Step<SetPipelineStep>

new SetPipelineStep(name, customise?): SetPipelineStep

Defined in: components/step/set-pipeline.ts:29

string

(instance) => void

SetPipelineStep

Step<Type.SetPipelineStep>.constructor

name: string

Defined in: components/step/set-pipeline.ts:30

Step.name

add_across(...across): void

Defined in: components/step/base.ts:57

https://concourse-ci.org/docs/steps/modifier-and-hooks/across/#across-step-modifier

...Across<Identifier>[]

The modifier to add

void

Step.add_across

---

add_ensure(step): void

Defined in: components/step/base.ts:249

Adds a step to always be run after this one.

https://concourse-ci.org/docs/steps/modifier-and-hooks/ensure/#ensure-step-hook

AnyStep

void

Step.add_ensure

---

add_on_abort(step): void

Defined in: components/step/base.ts:234

Adds a step to be run after this one is aborted.

https://concourse-ci.org/docs/steps/modifier-and-hooks/on-abort/#on_abort-step-hook

AnyStep

void

Step.add_on_abort

---

add_on_error(step): void

Defined in: components/step/base.ts:219

Adds a step to be run after this one errors.

https://concourse-ci.org/docs/steps/modifier-and-hooks/on-error/#on_error-step-hook

AnyStep

void

Step.add_on_error

---

add_on_failure(step): void

Defined in: components/step/base.ts:204

Adds a step to be run after this one fails.

https://concourse-ci.org/docs/steps/modifier-and-hooks/on-failure/#on_failure-step-hook

AnyStep

void

Step.add_on_failure

---

add_on_success(step): void

Defined in: components/step/base.ts:189

Adds a step to be run after this one succeeds.

https://concourse-ci.org/docs/steps/modifier-and-hooks/on-success/#on_success-step-hook

AnyStep

void

Step.add_on_success

---

add_tags(...tags): void

Defined in: components/step/base.ts:174

https://concourse-ci.org/docs/steps/modifier-and-hooks/tags/#tags-step-modifier

...string[]

void

Step.add_tags

---

add_var_file(...paths): void

Defined in: components/step/set-pipeline.ts:119

Adds paths to YAML files containing variables to pass to the pipeline.

https://concourse-ci.org/docs/steps/set-pipeline/#set_pipeline-step

...string[]

Paths to variable files

void

---

set_attempts(attempts): void

Defined in: components/step/base.ts:81

Sets the number of attempts for this step.

https://concourse-ci.org/docs/steps/modifier-and-hooks/attempts/#attempts-step-modifier

number

void

Step.set_attempts

---

set_file(file): void

Defined in: components/step/set-pipeline.ts:68

Sets the path to the pipeline configuration file. Required when not using an inline Pipeline instance.

https://concourse-ci.org/docs/steps/set-pipeline/#set_pipeline-step

string

Path to the pipeline YAML file

void

---

set_instance_vars(vars): void

Defined in: components/step/set-pipeline.ts:82

Sets instance variables for instanced pipelines. Instance variables are used to differentiate between instances of the same pipeline template.

https://concourse-ci.org/docs/steps/set-pipeline/#set_pipeline-step

Vars

Instance variable key-value pairs

void

---

set_pipeline(pipeline): void

Defined in: components/step/set-pipeline.ts:54

Sets the pipeline to configure. Can be a Pipeline instance or a string name. Use "self" to update the current pipeline.

https://concourse-ci.org/docs/steps/set-pipeline/#set_pipeline-step

The pipeline to set, or "self"

string | Pipeline<string>

void

---

set_team(team): void

Defined in: components/step/set-pipeline.ts:135

Sets the team to configure the pipeline on. By default, the pipeline is configured on the current team.

https://concourse-ci.org/docs/steps/set-pipeline/#set_pipeline-step

string

The team name

void

---

set_timeout(timeout): void

Defined in: components/step/base.ts:68

https://concourse-ci.org/docs/steps/modifier-and-hooks/timeout/#timeout-step-modifier

DurationInput

void

Step.set_timeout

---

set_vars(vars): void

Defined in: components/step/set-pipeline.ts:101

Sets template variables to pass to the pipeline configuration. These are used for parameterising pipeline templates.

https://concourse-ci.org/docs/steps/set-pipeline/#set_pipeline-step

Vars

Variable key-value pairs

void

---

static customise(init): void

Defined in: components/step/set-pipeline.ts:25

Customises all SetPipelineSteps constructed after calling this function.

Type.Customiser

(instance) => void

void

---

static customise_base(init): void

Defined in: components/step/base.ts:28

Customises the base of all Steps constructed after calling this function

Type.Customiser

(instance) => void

void

Step.customise_base