Class.SetPipelineStep

@decentm/concourse-ts / SetPipelineStep

Class: SetPipelineStep

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

Extends

Step<SetPipelineStep>

Constructors

new SetPipelineStep()

new SetPipelineStep(name, customise?): SetPipelineStep

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

Parameters

name

string

customise?

(instance) => void

Returns

SetPipelineStep

Overrides

Step<Type.SetPipelineStep>.constructor

Properties

attempts

attempts: number

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

https://concourse-ci.org/attempts-step.html

Inherited from

Step.attempts

file?

optional file: string

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

name

name: string

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

Inherited from

Step.name

set_pipeline

set_pipeline: string | Pipeline

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

team?

optional team: string

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

Methods

add_across()

add_across(...across): void

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

https://concourse-ci.org/across-step.html

Parameters

across

...Across<Identifier>[]

The modifier to add

Returns

void

Inherited from

Step.add_across

add_ensure()

add_ensure(step): void

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

Adds a step to always be run after this one.

https://concourse-ci.org/ensure-hook.html

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_ensure

add_on_abort()

add_on_abort(step): void

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

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

https://concourse-ci.org/on-abort-hook.html

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_on_abort

add_on_error()

add_on_error(step): void

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

Adds a step to be run after this one errors.

https://concourse-ci.org/on-error-hook.html

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_on_error

add_on_failure()

add_on_failure(step): void

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

Adds a step to be run after this one fails.

https://concourse-ci.org/on-failure-hook.html

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_on_failure

add_on_success()

add_on_success(step): void

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

Adds a step to be run after this one succeeds.

https://concourse-ci.org/on-success-step.html

Parameters

step

AnyStep

Returns

void

Inherited from

Step.add_on_success

add_tag()

add_tag(...tags): void

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

https://concourse-ci.org/tags-step.html

Parameters

Returns

void

Inherited from

Step.add_tag

add_var_file()

add_var_file(...paths): void

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

Parameters

paths

...string[]

Returns

void

set_instance_vars()

set_instance_vars(vars): void

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

Parameters

vars

Vars

Returns

void

set_timeout()

set_timeout(timeout): void

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

https://concourse-ci.org/timeout-step.html

Parameters

timeout

DurationInput

Returns

void

Inherited from

Step.set_timeout

set_vars()

set_vars(vars): void

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

Parameters

vars

Vars

Returns

void

customise()

static customise(init): void

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

Parameters

init

(instance) => void

Returns

void

customise_base()

static customise_base(init): void

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

Customises the base of all Steps constructed after calling this function

Type.Customiser

Parameters

init

(instance) => void

Returns

void

Inherited from

Step.customise_base