io.github.cdklabs.projen

Interface TaskStep

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStepOptions

All Known Implementing Classes:

TaskStep.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.449Z")
 @Stability(value=Experimental)
public interface TaskStep
extends software.amazon.jsii.JsiiSerializable, TaskStepOptions

(experimental) A single step within a task.

The step could either be the execution of a shell command or execution of a sub-task, by name.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TaskStep.Builder A builder for TaskStep
static class	TaskStep.Jsii$Proxy An implementation for TaskStep

Method Summary

Modifier and Type	Method and Description
static TaskStep.Builder	builder()
default String	getBuiltin() (experimental) The name of a built-in task to execute.
default String	getExec() (experimental) Shell command to execute.
default String	getSay() (experimental) Print a message.
default String	getSpawn() (experimental) Subtask to execute.

Methods inherited from interface io.github.cdklabs.projen.TaskStepOptions

getCwd, getName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBuiltin

@Stability(value=Experimental)
 @Nullable
default String getBuiltin()

(experimental) The name of a built-in task to execute.

Built-in tasks are node.js programs baked into the projen module and as component runtime helpers.

The name is a path relative to the projen lib/ directory (without the .task.js extension). For example, if your built in builtin task is under src/release/resolve-version.task.ts, then this would be release/resolve-version.

Default: - do not execute a builtin task

getExec

@Stability(value=Experimental)
 @Nullable
default String getExec()

(experimental) Shell command to execute.

Default: - don't execute a shell command

getSay

@Stability(value=Experimental)
 @Nullable
default String getSay()

(experimental) Print a message.

Default: - don't say anything

getSpawn

@Stability(value=Experimental)
 @Nullable
default String getSpawn()

(experimental) Subtask to execute.

Default: - don't spawn a subtask

builder

@Stability(value=Experimental)
static TaskStep.Builder builder()

Specified by:

builder in interface TaskStepOptions

Returns:

a TaskStep.Builder of TaskStep