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

Interface JobStep

All Superinterfaces:

JobStepConfiguration, software.amazon.jsii.JsiiSerializable, Step, StepConfiguration

All Known Implementing Classes:

JobStep.Jsii$Proxy

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

(experimental) JobSteps run as part of a GitHub Workflow Job.

See Also:

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsteps

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static JobStep.Builder	builder()
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	getWorkingDirectory()	(experimental) Specifies a working directory for a step.

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

getContinueOnError, getTimeoutMinutes

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

getRun, getUses, getWith

Method Detail

getEnv

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

Specified by:

getEnv in interface StepConfiguration

getId

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

(experimental) A unique identifier for the step.

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

Specified by:

getId in interface StepConfiguration

getIfValue

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

Specified by:

getIfValue in interface StepConfiguration

getName

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

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

Specified by:

getName in interface StepConfiguration

getWorkingDirectory

@Stability(Experimental)
@Nullable
default String getWorkingDirectory()

(experimental) Specifies a working directory for a step.

Overrides a job's working directory.

Specified by:

getWorkingDirectory in interface StepConfiguration

builder

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

Returns:

a JobStep.Builder of JobStep