Package io.github.cdklabs.projen.circleci

Interface Run

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

Run.Jsii$Proxy

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

(experimental) Used for invoking all command-line programs, taking either a map of configuration values, or, when called in its short-form, a string that will be used as both the command and name.

Run commands are executed using non-login shells by default, so you must explicitly source any dotfiles as part of the command.

Not used because type incompatible types in steps array

See Also:

https://circleci.com/docs/2.0/configuration-reference/#run

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static Run.Builder	builder()
default String	getBackground()	(experimental) Whether this step should run in the background (default: false).
String	getCommand()	(experimental) Command to run via the shell.
default String	getEnvironment()	(experimental) Additional environmental variables, locally scoped to command.
default String	getName()	(experimental) Title of the step to be shown in the CircleCI UI (default: full command).
default String	getNoOutputTimeout()	(experimental) Elapsed time the command can run without output such as “20m”, “1.25h”, “5s”.
default String	getShell()	(experimental) Shell to use for execution command.
default String	getWhen()	(experimental) Specify when to enable or disable the step.
default String	getWorkingDirectory()	(experimental) In which directory to run this step.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCommand

@Stability(Experimental)
@NotNull
String getCommand()

(experimental) Command to run via the shell.

getBackground

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

(experimental) Whether this step should run in the background (default: false).

getEnvironment

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

(experimental) Additional environmental variables, locally scoped to command.

getName

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

(experimental) Title of the step to be shown in the CircleCI UI (default: full command).

getNoOutputTimeout

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

(experimental) Elapsed time the command can run without output such as “20m”, “1.25h”, “5s”. The default is 10 minutes.

getShell

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

(experimental) Shell to use for execution command.

getWhen

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

(experimental) Specify when to enable or disable the step.

getWorkingDirectory

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

(experimental) In which directory to run this step.

Will be interpreted relative to the working_directory of the job). (default: .)

builder

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

Returns:

a Run.Builder of Run