Package io.github.cdklabs.projen.github
Interface TaskWorkflowJobOptions
-
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
TaskWorkflowOptions
- All Known Implementing Classes:
TaskWorkflowJobOptions.Jsii$Proxy,TaskWorkflowOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.96.0 (build 921e240)", date="2024-03-28T21:16:43.091Z") @Stability(Experimental) public interface TaskWorkflowJobOptions extends software.amazon.jsii.JsiiSerializable
(experimental) Options to create the Job associated with a TaskWorkflow.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classTaskWorkflowJobOptions.BuilderA builder forTaskWorkflowJobOptionsstatic classTaskWorkflowJobOptions.Jsii$ProxyAn implementation forTaskWorkflowJobOptions
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static TaskWorkflowJobOptions.Builderbuilder()default StringgetArtifactsDirectory()(experimental) A directory name which contains artifacts to be uploaded (e.g.default CheckoutWithgetCheckoutWith()(experimental) Override for thewithproperty of the source code checkout step.default StringgetCondition()(experimental) Adds an 'if' condition to the workflow.default ContainerOptionsgetContainer()Default: - default imagedefault BooleangetDownloadLfs()(experimental) Whether to download files from Git LFS for this workflow.default Map<String,String>getEnv()(experimental) Workflow environment variables.default GitIdentitygetGitIdentity()(experimental) The git identity to use in this workflow.default JobDefaultsgetJobDefaults()(experimental) Default settings for all steps in the TaskWorkflow Job.default Map<String,JobStepOutput>getOutputs()(experimental) Mapping of job output names to values/expressions.JobPermissionsgetPermissions()(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.default GroupRunnerOptionsgetRunsOnGroup()(experimental) Github Runner Group selection options.
-
-
-
Method Detail
-
getPermissions
@Stability(Experimental) @NotNull JobPermissions getPermissions()
(experimental) Permissions for the build job.
-
getArtifactsDirectory
@Stability(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(Experimental) @Nullable default CheckoutWith getCheckoutWith()
(experimental) Override for thewithproperty of the source code checkout step.Default: - not set
-
getCondition
@Stability(Experimental) @Nullable default String getCondition()
(experimental) Adds an 'if' condition to the workflow.
-
getContainer
@Stability(Experimental) @Nullable default ContainerOptions getContainer()
Default: - default image
-
getDownloadLfs
@Stability(Experimental) @Nullable default Boolean getDownloadLfs()
(experimental) Whether to download files from Git LFS for this workflow.Default: - Use the setting on the corresponding GitHub project
-
getEnv
@Stability(Experimental) @Nullable default Map<String,String> getEnv()
(experimental) Workflow environment variables.Default: {}
-
getGitIdentity
@Stability(Experimental) @Nullable default GitIdentity getGitIdentity()
(experimental) The git identity to use in this workflow.
-
getJobDefaults
@Stability(Experimental) @Nullable default JobDefaults getJobDefaults()
(experimental) Default settings for all steps in the TaskWorkflow Job.
-
getOutputs
@Stability(Experimental) @Nullable default Map<String,JobStepOutput> getOutputs()
(experimental) Mapping of job output names to values/expressions.Default: {}
-
getPostBuildSteps
@Stability(Experimental) @Nullable default List<JobStep> getPostBuildSteps()
(experimental) Actions to run after the main build step.Default: - not set
-
getPreBuildSteps
@Stability(Experimental) @Nullable default List<JobStep> getPreBuildSteps()
(experimental) Steps to run before the main build step.Default: - not set
-
getPreCheckoutSteps
@Stability(Experimental) @Nullable default List<JobStep> getPreCheckoutSteps()
(experimental) Initial steps to run before the source code checkout.Default: - not set
-
getRunsOn
@Stability(Experimental) @Nullable default List<String> getRunsOn()
(experimental) Github Runner selection labels.Default: ["ubuntu-latest"]
-
getRunsOnGroup
@Stability(Experimental) @Nullable default GroupRunnerOptions getRunsOnGroup()
(experimental) Github Runner Group selection options.
-
builder
@Stability(Experimental) static TaskWorkflowJobOptions.Builder builder()
- Returns:
- a
TaskWorkflowJobOptions.BuilderofTaskWorkflowJobOptions
-
-