io.github.cdklabs.projen.github

Class TaskWorkflow.Builder

java.lang.Object

io.github.cdklabs.projen.github.TaskWorkflow.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TaskWorkflow>

Enclosing class:

TaskWorkflow

@Stability(value=Experimental)
public static final class TaskWorkflow.Builder
extends Object
implements software.amazon.jsii.Builder<TaskWorkflow>

(experimental) A fluent builder for TaskWorkflow.

Method Summary

Modifier and Type	Method and Description
TaskWorkflow.Builder	artifactsDirectory(String artifactsDirectory) (experimental) A directory name which contains artifacts to be uploaded (e.g.
TaskWorkflow	build()
TaskWorkflow.Builder	checkoutWith(Map<String,? extends Object> checkoutWith) (experimental) Override for the `with` property of the source code checkout step.
TaskWorkflow.Builder	condition(String condition) (experimental) Adds an 'if' condition to the workflow.
TaskWorkflow.Builder	container(ContainerOptions container) Default: - default image
static TaskWorkflow.Builder	create(GitHub github)
TaskWorkflow.Builder	env(Map<String,String> env) (experimental) Workflow environment variables.
TaskWorkflow.Builder	gitIdentity(GitIdentity gitIdentity) (experimental) The git identity to use in this workflow.
TaskWorkflow.Builder	jobId(String jobId) (experimental) The primary job id.
TaskWorkflow.Builder	name(String name) (experimental) The workflow name.
TaskWorkflow.Builder	outputs(Map<String,? extends JobStepOutput> outputs) (experimental) Mapping of job output names to values/expressions.
TaskWorkflow.Builder	permissions(JobPermissions permissions) (experimental) Permissions for the build job.
TaskWorkflow.Builder	postBuildSteps(List<? extends JobStep> postBuildSteps) (experimental) Actions to run after the main build step.
TaskWorkflow.Builder	preBuildSteps(List<? extends JobStep> preBuildSteps) (experimental) Steps to run before the main build step.
TaskWorkflow.Builder	preCheckoutSteps(List<? extends JobStep> preCheckoutSteps) (experimental) Initial steps to run before the source code checkout.
TaskWorkflow.Builder	runsOn(List<String> runsOn) (experimental) Github Runner selection labels.
TaskWorkflow.Builder	task(Task task) (experimental) The main task to be executed.
TaskWorkflow.Builder	triggers(Triggers triggers) (experimental) The triggers for the workflow.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static TaskWorkflow.Builder create(GitHub github)

Parameters:

github - This parameter is required.

Returns:

a new instance of TaskWorkflow.Builder.

name

@Stability(value=Experimental)
public TaskWorkflow.Builder name(String name)

(experimental) The workflow name.

Parameters:

name - The workflow name. This parameter is required.

Returns:

this

permissions

@Stability(value=Experimental)
public TaskWorkflow.Builder permissions(JobPermissions permissions)

(experimental) Permissions for the build job.

Parameters:

permissions - Permissions for the build job. This parameter is required.

Returns:

this

task

@Stability(value=Experimental)
public TaskWorkflow.Builder task(Task task)

(experimental) The main task to be executed.

Parameters:

task - The main task to be executed. This parameter is required.

Returns:

this

artifactsDirectory

@Stability(value=Experimental)
public TaskWorkflow.Builder artifactsDirectory(String artifactsDirectory)

(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

Parameters:

artifactsDirectory - 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. This parameter is required.

Returns:

this

checkoutWith

@Stability(value=Experimental)
public TaskWorkflow.Builder checkoutWith(Map<String,? extends Object> checkoutWith)

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

Default: - not set

Parameters:

checkoutWith - Override for the `with` property of the source code checkout step. This parameter is required.

Returns:

this

condition

@Stability(value=Experimental)
public TaskWorkflow.Builder condition(String condition)

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

Parameters:

condition - Adds an 'if' condition to the workflow. This parameter is required.

Returns:

this

container

@Stability(value=Experimental)
public TaskWorkflow.Builder container(ContainerOptions container)

Default: - default image

Parameters:

container - This parameter is required.

Returns:

this

env

@Stability(value=Experimental)
public TaskWorkflow.Builder env(Map<String,String> env)

(experimental) Workflow environment variables.

Default: {}

Parameters:

env - Workflow environment variables. This parameter is required.

Returns:

this

gitIdentity

@Stability(value=Experimental)
public TaskWorkflow.Builder gitIdentity(GitIdentity gitIdentity)

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

Parameters:

gitIdentity - The git identity to use in this workflow. This parameter is required.

Returns:

this

jobId

@Stability(value=Experimental)
public TaskWorkflow.Builder jobId(String jobId)

(experimental) The primary job id.

Default: "build"

Parameters:

jobId - The primary job id. This parameter is required.

Returns:

this

outputs

@Stability(value=Experimental)
public TaskWorkflow.Builder outputs(Map<String,? extends JobStepOutput> outputs)

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

Default: {}

Parameters:

outputs - Mapping of job output names to values/expressions. This parameter is required.

Returns:

this

postBuildSteps

@Stability(value=Experimental)
public TaskWorkflow.Builder postBuildSteps(List<? extends JobStep> postBuildSteps)

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

Default: - not set

Parameters:

postBuildSteps - Actions to run after the main build step. This parameter is required.

Returns:

this

preBuildSteps

@Stability(value=Experimental)
public TaskWorkflow.Builder preBuildSteps(List<? extends JobStep> preBuildSteps)

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

Default: - not set

Parameters:

preBuildSteps - Steps to run before the main build step. This parameter is required.

Returns:

this

preCheckoutSteps

@Stability(value=Experimental)
public TaskWorkflow.Builder preCheckoutSteps(List<? extends JobStep> preCheckoutSteps)

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

Default: - not set

Parameters:

preCheckoutSteps - Initial steps to run before the source code checkout. This parameter is required.

Returns:

this

runsOn

@Stability(value=Experimental)
public TaskWorkflow.Builder runsOn(List<String> runsOn)

(experimental) Github Runner selection labels.

Default: ["ubuntu-latest"]

Parameters:

runsOn - Github Runner selection labels. This parameter is required.

Returns:

this

triggers

@Stability(value=Experimental)
public TaskWorkflow.Builder triggers(Triggers triggers)

(experimental) The triggers for the workflow.

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

Parameters:

triggers - The triggers for the workflow. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public TaskWorkflow build()

Specified by:

build in interface software.amazon.jsii.Builder<TaskWorkflow>