Package io.github.cdklabs.projen.github.workflows

Interface JobMatrix

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

JobMatrix.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.106Z")
@Stability(Experimental)
public interface JobMatrix
extends software.amazon.jsii.JsiiSerializable

(experimental) A job matrix.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static JobMatrix.Builder	builder()
default Map<String,List<Object>>	getDomain()	(experimental) Each option you define in the matrix has a key and value.
default List<Map<String,Object>>	getExclude()	(experimental) You can remove a specific configurations defined in the build matrix using the exclude option.
default List<Map<String,Object>>	getInclude()	(experimental) You can add additional configuration options to a build matrix job that already exists.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDomain

@Stability(Experimental)
@Nullable
default Map<String,List<Object>> getDomain()

(experimental) Each option you define in the matrix has a key and value.

The keys you define become properties in the matrix context and you can reference the property in other areas of your workflow file. For example, if you define the key os that contains an array of operating systems, you can use the matrix.os property as the value of the runs-on keyword to create a job for each operating system.

getExclude

@Stability(Experimental)
@Nullable
default List<Map<String,Object>> getExclude()

(experimental) You can remove a specific configurations defined in the build matrix using the exclude option.

Using exclude removes a job defined by the build matrix.

getInclude

@Stability(Experimental)
@Nullable
default List<Map<String,Object>> getInclude()

(experimental) You can add additional configuration options to a build matrix job that already exists.

For example, if you want to use a specific version of npm when the job that uses windows-latest and version 8 of node runs, you can use include to specify that additional option.

builder

@Stability(Experimental)
static JobMatrix.Builder builder()

Returns:

a JobMatrix.Builder of JobMatrix