Merge pull request #149 from buildkite/ming/pb-939

PB-939: Update pipeline YAML schema to match if_changed doc

Author: zhming0

schema.json

@@ -493,9 +493,58 @@
       }
     },
     "if_changed": {
-      "type": "string",
-      "description": "Agent-applied attribute: A glob pattern that omits the step from a build if it does not match any files changed in the build.",
-      "examples": ["**.go", "go.mod", "go.sum", "fixtures/**"]
+      "description": "Agent-applied attribute: A glob pattern that omits the step from a build if it does not match any files changed in the build. Can be a single pattern, list of patterns, or an object with include/exclude attributes.",
+      "oneOf": [
+        {
+          "type": "string",
+          "description": "A single glob pattern",
+          "examples": ["**.go", "go.{mod,sum}", "{app/**,spec/**}"]
+        },
+        {
+          "type": "array",
+          "description": "A list of glob patterns",
+          "items": {
+            "type": "string"
+          },
+          "examples": [["**.go", "go.{mod,sum}"], ["app/**", "spec/**"]]
+        },
+        {
+          "type": "object",
+          "description": "An object with include and optional exclude patterns",
+          "properties": {
+            "include": {
+              "description": "Pattern or list of patterns to include",
+              "oneOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              ]
+            },
+            "exclude": {
+              "description": "Pattern or list of patterns to exclude",
+              "oneOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              ]
+            }
+          },
+          "required": ["include"],
+          "additionalProperties": false
+        }
+      ]
     },
     "matrixElement": {
       "oneOf": [

test/schema.test.js

@@ -19,42 +19,45 @@ const validate = (name) => {
   }
 };
 
-describe("schema.json", function () {
-  it("should validate block steps", function () {
+describe("schema.json", function() {
+  it("should validate block steps", function() {
     validate("block.yml");
   });
-  it("should validate input steps", function () {
+  it("should validate input steps", function() {
     validate("input.yml");
   });
-  it("should validate command steps", function () {
+  it("should validate command steps", function() {
     validate("command.yml");
   });
-  it("should validate env blocks", function () {
+  it("should validate env blocks", function() {
     validate("env.yml");
   });
-  it("should validate blocks with extra properties", function () {
+  it("should validate blocks with extra properties", function() {
     validate("extra-properties.yml");
   });
-  it("should validate step groups", function () {
+  it("should validate step groups", function() {
     validate("group.yml");
   });
-  it("should validate trigger steps", function () {
+  it("should validate trigger steps", function() {
     validate("trigger.yml");
   });
-  it("should validate wait steps", function () {
+  it("should validate wait steps", function() {
     validate("wait.yml");
   });
-  it("should validate notify", function () {
+  it("should validate notify", function() {
     validate("notify.yml");
   });
-  it("should validate matrix", function () {
+  it("should validate matrix", function() {
     validate("matrix.yml");
   });
-  it("should validate secrets", function () {
+  it("should validate secrets", function() {
     validate("secrets.yml");
   });
+  it("should if-changed", function() {
+    validate("if-changed.yml");
+  });
 
-  it("should verify groupStep.steps uses the same-ish items as root steps", function () {
+  it("should verify groupStep.steps uses the same-ish items as root steps", function() {
     const mainList = schema.definitions.pipelineSteps.items.anyOf;
     const groupList = schema.definitions.groupSteps.items.anyOf;
     expect(mainList.slice(0, -1)).to.eql(groupList);

test/valid-pipelines/if-changed.yml

@@ -0,0 +1,47 @@
+steps:
+  # Always runs
+  - command: "always runs"
+
+  # Single string pattern
+  - command: "only runs when files in foo changed"
+    if_changed: "foo/**"
+
+  # Include/exclude object pattern
+  - command: "only runs when files in foo changed, except for baz"
+    if_changed:
+      include: "foo/**"
+      exclude: "foo/baz"
+
+  # Single string pattern for bar
+  - command: "only runs when files in bar changed"
+    if_changed: "bar/**"
+
+  # Array of patterns
+  - command: "only runs when files in foo or bar changed"
+    if_changed:
+      - "foo/**"
+      - "bar/**"
+
+  # Match all files
+  - command: "only runs when any files changed"
+    if_changed: "**"
+
+  # Complex include/exclude with arrays
+  - command: "runs for api and internal, but not api/docs or internal .py files"
+    if_changed:
+      include:
+        - "api/**"
+        - "internal/**"
+      exclude:
+        - "api/docs/**"
+        - "internal/**.py"
+
+  # Braces pattern
+  - command: "runs for Go-related files"
+    if_changed: "{**.go,go.{mod,sum}}"
+
+  # Include/exclude with single exclude pattern
+  - command: "runs for spec/ but not spec/integration/"
+    if_changed:
+      include: "spec/**"
+      exclude: "spec/integration/**"