io.github.cdklabs.projen.github.workflows

Class Job.Builder

java.lang.Object

io.github.cdklabs.projen.github.workflows.Job.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Job>

Enclosing interface:

Job

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

A builder for Job

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Job	build() Builds the configured instance.
Job.Builder	concurrency(Object concurrency) Sets the value of Job.getConcurrency()
Job.Builder	container(ContainerOptions container) Sets the value of Job.getContainer()
Job.Builder	continueOnError(Boolean continueOnError) Sets the value of Job.getContinueOnError()
Job.Builder	defaults(JobDefaults defaults) Sets the value of Job.getDefaults()
Job.Builder	env(Map<String,String> env) Sets the value of Job.getEnv()
Job.Builder	environment(Object environment) Sets the value of Job.getEnvironment()
Job.Builder	ifValue(String ifValue) Sets the value of Job.getIfValue()
Job.Builder	name(String name) Sets the value of Job.getName()
Job.Builder	needs(List<String> needs) Sets the value of Job.getNeeds()
Job.Builder	outputs(Map<String,? extends JobStepOutput> outputs) Sets the value of Job.getOutputs()
Job.Builder	permissions(JobPermissions permissions) Sets the value of Job.getPermissions()
Job.Builder	runsOn(List<String> runsOn) Sets the value of Job.getRunsOn()
Job.Builder	services(Map<String,? extends ContainerOptions> services) Sets the value of Job.getServices()
Job.Builder	steps(List<? extends JobStep> steps) Sets the value of Job.getSteps()
Job.Builder	strategy(JobStrategy strategy) Sets the value of Job.getStrategy()
Job.Builder	timeoutMinutes(Number timeoutMinutes) Sets the value of Job.getTimeoutMinutes()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

permissions

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

Sets the value of Job.getPermissions()

Parameters:

permissions - You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access. This parameter is required. Use { contents: READ } if your job only needs to clone code.

This is intentionally a required field since it is required in order to allow workflows to run in GitHub repositories with restricted default access.

Returns:

this

runsOn

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

Sets the value of Job.getRunsOn()

Parameters:

runsOn - The type of machine to run the job on. This parameter is required. The machine can be either a GitHub-hosted runner or a self-hosted runner.

Returns:

this

steps

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

Sets the value of Job.getSteps()

Parameters:

steps - A job contains a sequence of tasks called steps. This parameter is required. Steps can run commands, run setup tasks, or run an action in your repository, a public repository, or an action published in a Docker registry. Not all steps run actions, but all actions run as a step. Each step runs in its own process in the runner environment and has access to the workspace and filesystem. Because steps run in their own process, changes to environment variables are not preserved between steps. GitHub provides built-in steps to set up and complete a job.

Returns:

this

concurrency

@Stability(value=Experimental)
public Job.Builder concurrency(Object concurrency)

Sets the value of Job.getConcurrency()

Parameters:

concurrency - Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context.

Returns:

this

container

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

Sets the value of Job.getContainer()

Parameters:

container - A container to run any steps in a job that don't already specify a container. If you have steps that use both script and container actions, the container actions will run as sibling containers on the same network with the same volume mounts.

Returns:

this

continueOnError

@Stability(value=Experimental)
public Job.Builder continueOnError(Boolean continueOnError)

Sets the value of Job.getContinueOnError()

Parameters:

continueOnError - Prevents a workflow run from failing when a job fails. Set to true to allow a workflow run to pass when this job fails.

Returns:

this

defaults

@Stability(value=Experimental)
public Job.Builder defaults(JobDefaults defaults)

Sets the value of Job.getDefaults()

Parameters:

defaults - A map of default settings that will apply to all steps in the job. You can also set default settings for the entire workflow.

Returns:

this

env

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

Sets the value of Job.getEnv()

Parameters:

env - A map of environment variables that are available to all steps in the job. You can also set environment variables for the entire workflow or an individual step.

Returns:

this

environment

@Stability(value=Experimental)
public Job.Builder environment(Object environment)

Sets the value of Job.getEnvironment()

Parameters:

environment - The environment that the job references. All environment protection rules must pass before a job referencing the environment is sent to a runner.

Returns:

this

ifValue

@Stability(value=Experimental)
public Job.Builder ifValue(String ifValue)

Sets the value of Job.getIfValue()

Parameters:

ifValue - You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional.

Returns:

this

name

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

Sets the value of Job.getName()

Parameters:

name - The name of the job displayed on GitHub.

Returns:

this

needs

@Stability(value=Experimental)
public Job.Builder needs(List<String> needs)

Sets the value of Job.getNeeds()

Parameters:

needs - Identifies any jobs that must complete successfully before this job will run. It can be a string or array of strings. If a job fails, all jobs that need it are skipped unless the jobs use a conditional expression that causes the job to continue.

Returns:

this

outputs

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

Sets the value of Job.getOutputs()

Parameters:

outputs - A map of outputs for a job. Job outputs are available to all downstream jobs that depend on this job.

Returns:

this

services

@Stability(value=Experimental)
public Job.Builder services(Map<String,? extends ContainerOptions> services)

Sets the value of Job.getServices()

Parameters:

services - Used to host service containers for a job in a workflow. Service containers are useful for creating databases or cache services like Redis. The runner automatically creates a Docker network and manages the life cycle of the service containers.

Returns:

this

strategy

@Stability(value=Experimental)
public Job.Builder strategy(JobStrategy strategy)

Sets the value of Job.getStrategy()

Parameters:

strategy - A strategy creates a build matrix for your jobs. You can define different variations to run each job in.

Returns:

this

timeoutMinutes

@Stability(value=Experimental)
public Job.Builder timeoutMinutes(Number timeoutMinutes)

Sets the value of Job.getTimeoutMinutes()

Parameters:

timeoutMinutes - The maximum number of minutes to let a job run before GitHub automatically cancels it.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of Job

Throws:

NullPointerException - if any required attribute was not provided