Package io.github.cdklabs.projen.github.workflows

Interface JobStepConfiguration

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, StepConfiguration

All Known Subinterfaces:

CheckoutOptions, DownloadArtifactOptions, JobStep, SetupGitIdentityOptions, UploadArtifactOptions

All Known Implementing Classes:

CheckoutOptions.Jsii$Proxy, DownloadArtifactOptions.Jsii$Proxy, JobStep.Jsii$Proxy, JobStepConfiguration.Jsii$Proxy, SetupGitIdentityOptions.Jsii$Proxy, UploadArtifactOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.108Z")
@Stability(Experimental)
public interface JobStepConfiguration
extends software.amazon.jsii.JsiiSerializable, StepConfiguration

(experimental) These settings are unique to a JobStep from the fields contained within the metadata action.yaml file present in when creating a new GitHub Action. These fields are not present in action.yml, but are in JobStep, which are using when creating workflows.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static JobStepConfiguration.Builder	builder()
default Boolean	getContinueOnError()	(experimental) Prevents a job from failing when a step fails.
default Number	getTimeoutMinutes()	(experimental) The maximum number of minutes to run the step before killing the process.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface io.github.cdklabs.projen.github.workflows.StepConfiguration

getEnv, getId, getIfValue, getName, getWorkingDirectory

Method Detail

getContinueOnError

@Stability(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.

getTimeoutMinutes

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

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

builder

@Stability(Experimental)
static JobStepConfiguration.Builder builder()

Returns:

a JobStepConfiguration.Builder of JobStepConfiguration