-
Notifications
You must be signed in to change notification settings - Fork 0
Class.TaskStep
@decentm/concourse-ts / TaskStep
Defined in: components/step/task.ts:17
Executes a task, which is the smallest configurable unit in a Concourse pipeline. A task can run any script in any container, with any inputs and outputs.
https://concourse-ci.org/docs/steps/task/
-
Step<TaskStep>
• Input extends Identifier = Identifier
• Output extends Identifier = Identifier
new TaskStep<
Input,Output>(name,customise?):TaskStep<Input,Output>
Defined in: components/step/task.ts:34
string
(instance) => void
TaskStep<Input, Output>
Step<Type.TaskStep>.constructor
name:
string
Defined in: components/step/task.ts:35
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_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
get_task():
Task<Input,Output>
Defined in: components/step/task.ts:68
Returns the task configuration set on this step.
Task<Input, Output>
The task configuration, if set
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/task.ts:82
Sets the path to an external task configuration file. When set, the task config is loaded from this file instead of inline config.
https://concourse-ci.org/docs/steps/task/#task-step
string
Path to the task config file (e.g., "my-repo/ci/task.yml")
void
set_image(
image):void
Defined in: components/step/task.ts:96
Sets an artifact source containing an image to use for the task. Overrides the image specified in the task configuration.
https://concourse-ci.org/docs/steps/task/#task-step
string
The name of the artifact containing the image
void
set_input_mapping(
input,mapped_input):void
Defined in: components/step/task.ts:162
Maps an artifact name to a different input name expected by the task. Useful when artifact names don't match what the task config expects.
https://concourse-ci.org/docs/steps/task/#task-step
string
The artifact name available in the job
string
The input name expected by the task
void
set_output_mapping(
output,mapped_output):void
Defined in: components/step/task.ts:179
Maps a task output name to a different artifact name. Useful when the task outputs need to be renamed for downstream steps.
https://concourse-ci.org/docs/steps/task/#task-step
string
The output name produced by the task
string
The artifact name to use in the job
void
set_params(
params):void
Defined in: components/step/task.ts:142
Sets environment variables to pass to the task. These override any parameters set in the task configuration.
https://concourse-ci.org/docs/steps/task/#task-step
Environment variables to set
void
set_privileged():
void
Defined in: components/step/task.ts:109
Sets "privileged" to true - avoid calling to keep false. Running a task with elevated privileges allows the container to have full access to the host machine.
https://concourse-ci.org/docs/steps/task/#task-step
void
set_task(
task):void
Defined in: components/step/task.ts:59
Sets the task configuration to run. The task defines what container image to use, what command to run, and what inputs/outputs are expected.
https://concourse-ci.org/docs/steps/task/#task-step
Task<Input, Output>
The task configuration
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
void
Step.set_timeout
set_vars(
vars):void
Defined in: components/step/task.ts:123
Sets template variables to pass to the task. These can be used for parameterising task configs loaded from files.
https://concourse-ci.org/docs/steps/task/#task-step
Key-value pairs for template variables
void
staticcustomise(init):void
Defined in: components/step/task.ts:30
Customises all TaskSteps 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