matrix attribute on command steps

Author: pda

schema.json

@@ -406,6 +406,13 @@
           ]
         }
       },
+      "matrixElement": {
+        "oneOf": [
+          {"type": "string"},
+          {"type": "integer"},
+          {"type": "boolean"}
+        ]
+      },
       "prompt": {
         "type": "string",
         "description": "The instructional message displayed in the dialog box when the unblock step is activated",
@@ -659,6 +666,98 @@
         "label": {
           "$ref": "#/definitions/commonOptions/label"
         },
+        "matrix": {
+          "oneOf": [
+            {
+              "type": "array",
+              "description": "List of elements for simple single-dimension Build Matrix",
+              "items": { "$ref": "#/definitions/commonOptions/matrixElement" },
+              "examples": [
+                ["linux", "freebsd"]
+              ]
+            },
+            {
+              "type": "object",
+              "description": "Configuration for multi-dimension Build Matrix",
+              "properties": {
+                "setup": {
+                  "oneOf": [
+                    {
+                      "type": "array",
+                      "description": "List of elements for single-dimension Build Matrix",
+                      "items": { "$ref": "#/definitions/commonOptions/matrixElement" },
+                      "examples": [
+                        ["linux", "freebsd"]
+                      ]
+                    },
+                    {
+                      "type": "object",
+                      "description": "Mapping of Build Matrix dimension names to their lists of elements",
+                      "propertyNames": {
+                        "type": "string",
+                        "description": "Build Matrix dimension name",
+                        "pattern": "^[a-zA-Z0-9_]+$"
+                      },
+                      "additionalProperties": {
+                        "type": "array",
+                        "description": "List of elements for this Build Matrix dimension",
+                        "items": { "$ref": "#/definitions/commonOptions/matrixElement" }
+                      },
+                      "examples": [
+                        {
+                          "os": ["linux", "freebsd"],
+                          "arch": ["arm64", "riscv"]
+                        }
+                      ]
+                    }
+                  ]
+                },
+                "adjustments": {
+                  "type": "array",
+                  "description": "List of Build Matrix adjustments",
+                  "items": {
+                    "type": "object",
+                    "description": "An adjustment to a Build Matrix",
+                    "properties": {
+                      "with": {
+                        "oneOf": [
+                          {
+                            "type": "array",
+                            "description": "List of existing or new elements for single-dimension Build Matrix",
+                            "items": { "$ref": "#/definitions/commonOptions/matrixElement" }
+                          },
+                          {
+                            "type": "object",
+                            "description": "Specification of a new or existing Build Matrix combination",
+                            "propertyNames": {
+                              "type": "string",
+                              "description": "Build Matrix dimension name"
+                            },
+                            "additionalProperties": {
+                              "type": "string",
+                              "description": "Build Matrix dimension element"
+                            },
+                            "examples": [
+                              { "os": "linux", "arch": "arm64" }
+                            ]
+                          }
+                        ]
+                      },
+                      "skip": {
+                        "$ref": "#/definitions/commonOptions/skip"
+                      },
+                      "soft_fail": {
+                        "$ref": "#/definitions/commonOptions/softFail"
+                      }
+                    },
+                    "required": ["with"]
+                  }
+                }
+              },
+              "required": ["setup"]
+            }
+          ]
+        },
         "name": {
           "$ref": "#/definitions/commonOptions/label"
         },

test/schema.test.js

@@ -46,4 +46,7 @@ describe('schema.json', function() {
   it('should validate notify', function() {
     validate('notify.yml')
   })
+  it('should validate matrix', function() {
+    validate('matrix.yml')
+  })
 })

test/valid-pipelines/matrix.yml

@@ -0,0 +1,53 @@
+steps:
+  - command: "echo {{matrix}}"
+    label: "{{matrix}}"
+    matrix:
+      - one
+      - two
+
+  - command: "echo {{matrix}}"
+    label: "{{matrix}}"
+    matrix:
+      setup:
+        - one
+        - two
+      adjustments:
+        - with: ["three"]
+          skip: true
+
+  - command: "echo {{matrix.color}} {{matrix.shape}}"
+    label: "{{matrix.color}} {{matrix.shape}}"
+    matrix:
+      setup:
+        color:
+          - green
+          - blue
+        shape:
+          - triangle
+          - hexagon
+      adjustments:
+        - with: {color: blue, shape: triangle}
+          skip: true
+        - with: {color: green, shape: triangle}
+          skip: "look, hexagons are just better"
+        - with: {color: purple, shape: octagon}
+
+
+  - group: matrices
+    steps:
+      - command: "echo {{matrix}}"
+        label: "{{matrix}}"
+        matrix:
+          - one
+          - two
+
+      - command: "echo {{matrix.color}} {{matrix.shape}}"
+        label: "{{matrix.color}} {{matrix.shape}}"
+        matrix:
+          setup:
+            color:
+              - green
+              - blue
+            shape:
+              - triangle
+              - hexagon