-
Notifications
You must be signed in to change notification settings - Fork 0
Class.DoStep
@decentm/concourse-ts / DoStep
Defined in: components/step/do.ts:13
https://concourse-ci.org/docs/steps/do/
-
Step<DoStep>
new DoStep(
name,customise?):DoStep
Defined in: components/step/do.ts:27
string
(instance) => void
Step<Type.DoStep>.constructor
name:
string
Defined in: components/step/do.ts:28
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
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
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
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
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
void
Step.add_on_success
add_steps(...
steps):void
Defined in: components/step/do.ts:49
Adds a step after existing steps into this DoStep
...AnyStep[]
void
add_steps_first(...
steps):void
Defined in: components/step/do.ts:58
Adds a step that runs before all existing steps in this DoStep
...AnyStep[]
void
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
serialise():
DoStep
Defined in: components/step/do.ts:92
Serialises this step into a valid Concourse configuration fixture. The returned value needs to be converted into YAML to be used in Concourse.
Step.serialise
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_timeout(
timeout):void
Defined in: components/step/base.ts:68
https://concourse-ci.org/docs/steps/modifier-and-hooks/timeout/#timeout-step-modifier
void
Step.set_timeout
staticcustomise(init):void
Defined in: components/step/do.ts:23
Customises all DoSteps constructed after calling this function
(instance) => void
void
staticcustomise_base(init):void
Defined in: components/step/base.ts:28
Customises the base of all Steps constructed after calling this function
(instance) => void
void
Step.customise_base