Interface Step
-
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable,StepConfiguration
- All Known Subinterfaces:
JobStep
- All Known Implementing Classes:
JobStep.Jsii$Proxy,Step.Jsii$Proxy
@Generated(value="jsii-pacmak/1.96.0 (build 921e240)", date="2024-03-28T21:16:43.111Z") @Stability(Experimental) public interface Step extends software.amazon.jsii.JsiiSerializable, StepConfiguration
(experimental) This contains the fields that are common amongst both: - JobStep, which is a step that is part of a Job in Github Actions.This is by far the most common use case.
- The metadata file
action.yamlthat is used to define an Action when you are creating one. As in, if you were creating an Action to be used in a JobStep. There is some overlap between the two, and this captures that overlap.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classStep.BuilderA builder forStepstatic classStep.Jsii$ProxyAn implementation forStep
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static Step.Builderbuilder()default StringgetRun()(experimental) Runs command-line programs using the operating system's shell.default StringgetUses()(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 io.github.cdklabs.projen.github.workflows.StepConfiguration
getEnv, getId, getIfValue, getName, getWorkingDirectory
-
-
-
-
Method Detail
-
getRun
@Stability(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.
-
getUses
@Stability(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(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(Experimental) static Step.Builder builder()
- Returns:
- a
Step.BuilderofStep
-
-