Documentation

Matrix strategy configuration for running job variations.

Matrix strategies define how to run a job multiple times with different configurations. The matrix creates a cross-product of all variable combinations, with options to include additional combinations or exclude specific ones.

Example usage:

import Language.Github.Actions.Job.Strategy
import qualified Data.Map as Map
import qualified Data.Aeson as Aeson

-- Simple OS and Node version matrix
nodeMatrix :: JobStrategy
nodeMatrix = JobStrategy
 { exclude = Nothing
 , failFast = Just False
 , include = Nothing
 , maxParallel = Just 3
 , otherVariables = Just $ Map.fromList
     [ ("os", Aeson.toJSON ["ubuntu-latest", "windows-latest", "macos-latest"])
     , ("node-version", Aeson.toJSON ["16", "18", "20"])
     ]
 }

-- Matrix with exclusions and includes
complexMatrix :: JobStrategy
complexMatrix = JobStrategy
 { exclude = Just ["{ "os": "windows-latest", "node-version": "16" }"]
 , failFast = Just True
 , include = Just ["{ "os": "ubuntu-latest", "node-version": "21", "experimental": true }"]
 , maxParallel = Nothing
 , otherVariables = Just $ Map.fromList
     [ ("os", Aeson.toJSON ["ubuntu-latest", "windows-latest"])
     , ("node-version", Aeson.toJSON ["18", "20"])
     ]
 }

For more details, see: https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/running-variations-of-jobs-in-a-workflow