io.github.cdklabs.projen.github

Interface TaskWorkflowOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TaskWorkflowOptions.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static TaskWorkflowOptions.Builder	builder()
default String	getArtifactsDirectory() (experimental) A directory name which contains artifacts to be uploaded (e.g.
default Map<String,Object>	getCheckoutWith() (experimental) Override for the `with` property of the source code checkout step.
default String	getCondition() (experimental) Adds an 'if' condition to the workflow.
default ContainerOptions	getContainer() Default: - default image
default Map<String,String>	getEnv() (experimental) Workflow environment variables.
default GitIdentity	getGitIdentity() (experimental) The git identity to use in this workflow.
default String	getJobId() (experimental) The primary job id.
String	getName() (experimental) The workflow name.
default Map<String,JobStepOutput>	getOutputs() (experimental) Mapping of job output names to values/expressions.
JobPermissions	getPermissions() (experimental) Permissions for the build job.
default List<JobStep>	getPostBuildSteps() (experimental) Actions to run after the main build step.
default List<JobStep>	getPreBuildSteps() (experimental) Steps to run before the main build step.
default List<JobStep>	getPreCheckoutSteps() (experimental) Initial steps to run before the source code checkout.
default List<String>	getRunsOn() (experimental) Github Runner selection labels.
Task	getTask() (experimental) The main task to be executed.
default Triggers	getTriggers() (experimental) The triggers for the workflow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Experimental)
 @NotNull
String getName()

(experimental) The workflow name.

getPermissions

@Stability(value=Experimental)
 @NotNull
JobPermissions getPermissions()

(experimental) Permissions for the build job.

getTask

@Stability(value=Experimental)
 @NotNull
Task getTask()

(experimental) The main task to be executed.

getArtifactsDirectory

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

(experimental) A directory name which contains artifacts to be uploaded (e.g. `dist`). If this is set, the contents of this directory will be uploaded as an artifact at the end of the workflow run, even if other steps fail.

Default: - not set

getCheckoutWith

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

(experimental) Override for the `with` property of the source code checkout step.

Default: - not set

getCondition

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

(experimental) Adds an 'if' condition to the workflow.

getContainer

@Stability(value=Experimental)
 @Nullable
default ContainerOptions getContainer()

Default: - default image

getEnv

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

(experimental) Workflow environment variables.

Default: {}

getGitIdentity

@Stability(value=Experimental)
 @Nullable
default GitIdentity getGitIdentity()

(experimental) The git identity to use in this workflow.

getJobId

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

(experimental) The primary job id.

Default: "build"

getOutputs

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

(experimental) Mapping of job output names to values/expressions.

Default: {}

getPostBuildSteps

@Stability(value=Experimental)
 @Nullable
default List<JobStep> getPostBuildSteps()

(experimental) Actions to run after the main build step.

Default: - not set

getPreBuildSteps

@Stability(value=Experimental)
 @Nullable
default List<JobStep> getPreBuildSteps()

(experimental) Steps to run before the main build step.

Default: - not set

getPreCheckoutSteps

@Stability(value=Experimental)
 @Nullable
default List<JobStep> getPreCheckoutSteps()

(experimental) Initial steps to run before the source code checkout.

Default: - not set

getRunsOn

@Stability(value=Experimental)
 @Nullable
default List<String> getRunsOn()

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

getTriggers

@Stability(value=Experimental)
 @Nullable
default Triggers getTriggers()

(experimental) The triggers for the workflow.

Default: - by default workflows can only be triggered by manually.

builder

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

Returns:

a TaskWorkflowOptions.Builder of TaskWorkflowOptions