io.github.cdklabs.projen.github.workflows

Interface JobStrategy

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

JobStrategy.Jsii$Proxy

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

(experimental) A strategy creates a build matrix for your jobs.

You can define different variations to run each job in.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static JobStrategy.Builder	builder()
default Boolean	getFailFast() (experimental) When set to true, GitHub cancels all in-progress jobs if any matrix job fails.
default JobMatrix	getMatrix() (experimental) You can define a matrix of different job configurations.
default Number	getMaxParallel() (experimental) The maximum number of jobs that can run simultaneously when using a matrix job strategy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getFailFast

@Stability(value=Experimental)
 @Nullable
default Boolean getFailFast()

(experimental) When set to true, GitHub cancels all in-progress jobs if any matrix job fails.

Default: true

getMatrix

@Stability(value=Experimental)
 @Nullable
default JobMatrix getMatrix()

(experimental) You can define a matrix of different job configurations.

A matrix allows you to create multiple jobs by performing variable substitution in a single job definition. For example, you can use a matrix to create jobs for more than one supported version of a programming language, operating system, or tool. A matrix reuses the job's configuration and creates a job for each matrix you configure.

A job matrix can generate a maximum of 256 jobs per workflow run. This limit also applies to self-hosted runners.

getMaxParallel

@Stability(value=Experimental)
 @Nullable
default Number getMaxParallel()

(experimental) The maximum number of jobs that can run simultaneously when using a matrix job strategy.

By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines.

builder

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

Returns:

a JobStrategy.Builder of JobStrategy