Interface JobStrategy

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    JobStrategy.Jsii$Proxy

    @Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
               date="2024-03-28T21:16:43.108Z")
    @Stability(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.

    • Method Detail

      • getFailFast

        @Stability(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(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(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.