io.github.cdklabs.projen.github.workflows

Interface JobStep

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

JobStep.Jsii$Proxy

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

(experimental) A job step.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static JobStep.Builder	builder()
default Boolean	getContinueOnError() (experimental) Prevents a job from failing when a step fails.
default Map<String,String>	getEnv() (experimental) Sets environment variables for steps to use in the runner environment.
default String	getId() (experimental) A unique identifier for the step.
default String	getIfValue() (experimental) You can use the if conditional to prevent a job from running unless a condition is met.
default String	getName() (experimental) A name for your step to display on GitHub.
default String	getRun() (experimental) Runs command-line programs using the operating system's shell.
default Number	getTimeoutMinutes() (experimental) The maximum number of minutes to run the step before killing the process.
default String	getUses() (experimental) Selects an action to run as part of a step in your job.
default Map<String,Object>	getWith() (experimental) A map of the input parameters defined by the action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getContinueOnError

@Stability(value=Experimental)
 @Nullable
default Boolean getContinueOnError()

(experimental) Prevents a job from failing when a step fails.

Set to true to allow a job to pass when this step fails.

getEnv

@Stability(value=Experimental)
 @Nullable
default Map<String,String> getEnv()

(experimental) Sets environment variables for steps to use in the runner environment.

You can also set environment variables for the entire workflow or a job.

getId

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

(experimental) A unique identifier for the step.

You can use the id to reference the step in contexts.

getIfValue

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

(experimental) You can use the if conditional to prevent a job from running unless a condition is met.

You can use any supported context and expression to create a conditional.

getName

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

(experimental) A name for your step to display on GitHub.

getRun

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

(experimental) Runs command-line programs using the operating system's shell.

If you do not provide a name, the step name will default to the text specified in the run command.

getTimeoutMinutes

@Stability(value=Experimental)
 @Nullable
default Number getTimeoutMinutes()

(experimental) The maximum number of minutes to run the step before killing the process.

getUses

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

(experimental) Selects an action to run as part of a step in your job.

An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image.

getWith

@Stability(value=Experimental)
 @Nullable
default Map<String,Object> getWith()

(experimental) A map of the input parameters defined by the action.

Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.

builder

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

Returns:

a JobStep.Builder of JobStep