Merge pull request #92 from jasonwbarnett/jwb/add-if-support

feat: Add support for conditionals (if key) in Step struct

Author: pzeballos

README.md

@@ -45,7 +45,7 @@ For example, in the following configuration:
 steps:
   - label: "Triggering pipelines"
     plugins:
-      - monorepo-diff#v1.4.0:
+      - monorepo-diff#v1.5.0:
           diff: "git diff --name-only HEAD~1"
           watch:
             - path: "**/*"
@@ -70,14 +70,15 @@ This is a sub-section that provides configuration for running commands or trigge
 - [Trigger](https://buildkite.com/docs/pipelines/configure/step-types/trigger-step)
 - [Command](https://buildkite.com/docs/pipelines/configure/step-types/command-step)
 - [Group](https://buildkite.com/docs/pipelines/configure/step-types/group-step)
+- [Conditionals](https://buildkite.com/docs/pipelines/conditionals)
 
 :warning: This plugin may accept configurations that are not valid pipeline steps, this is a known issue to keep its code simple and flexible.
 
 ```yaml
 steps:
   - label: "Triggering pipelines"
     plugins:
-      - monorepo-diff#v1.4.0:
+      - monorepo-diff#v1.5.0:
           watch:
             - path: app/
               config:
@@ -108,7 +109,7 @@ steps:
 steps:
   - label: "Triggering pipelines with plugin"
     plugins:
-      - monorepo-diff#v1.4.0:
+      - monorepo-diff#v1.5.0:
           watch:
             - path: test/.buildkite/
               config: # Required [trigger step configuration]
@@ -127,6 +128,34 @@ steps:
 - When changes are detected in the path `test/.buildkite/` it triggers the pipeline `test-pipeline`
 - If the changes are made to either `app/` or `app/bin/service/` it triggers the pipeline `data-generator`
 
+**Conditional Step Execution (`if`):**
+
+The plugin supports conditional execution of pipeline steps using the `if` key, matching Buildkite’s pipeline conditional syntax. The `if` key allows you to control when a step runs, based on branch names, environment variables, build metadata, or custom expressions.
+
+**Example**
+
+```yaml
+steps:
+  - label: "Triggering pipelines with plugin"
+    plugins:
+      - monorepo-diff#v1.5.0:
+          diff: git diff --name-only HEAD~1
+          watch:
+            - path: services/api
+              config:
+                trigger: deploy-api
+                if: build.branch == 'main' || build.branch =~ /^release\//
+            - path: services/web
+              config:
+                command: echo "Deploy Web"
+                if: build.tag != null
+```
+
+In the example above, 
+- The `deploy-api` trigger will only run on the main branch or branches matching `release/*`.
+- The `web deployment` command will run only if the build has a tag.
+
+
 #### `diff` (optional)
 
 This will run the script provided to determine the folder changes.
@@ -172,7 +201,7 @@ git diff --name-only "$LATEST_TAG"
 steps:
   - label: "Triggering pipelines"
     plugins:
-      - monorepo-diff#v1.4.0:
+      - monorepo-diff#v1.5.0:
           diff: "git diff --name-only HEAD~1"
           watch:
             - path: "bar-service/"
@@ -199,7 +228,7 @@ A default `config` to run if no paths are matched, the `config` key is not requi
 steps:
   - label: "Triggering pipelines"
     plugins:
-      - monorepo-diff#v1.4.0:
+      - monorepo-diff#v1.5.0:
           diff: "git diff --name-only HEAD~1"
           watch:
             - path: "bar-service/"
@@ -221,7 +250,7 @@ The object values provided in this configuration will be appended to `env` prope
 steps:
   - label: "Triggering pipelines"
     plugins:
-      - monorepo-diff#v1.4.0:
+      - monorepo-diff#v1.5.0:
           diff: "git diff --name-only HEAD~1"
           watch:
             - path: "foo-service/"
@@ -243,7 +272,7 @@ Add `log_level` property to set the log level. Supported log levels are `debug`
 steps:
   - label: "Triggering pipelines"
     plugins:
-      - monorepo-diff#v1.4.0:
+      - monorepo-diff#v1.5.0:
           diff: "git diff --name-only HEAD~1"
           log_level: "debug" # defaults to "info"
           watch:
@@ -274,7 +303,7 @@ By setting `wait` to `true`, the build will wait until the triggered pipeline bu
 steps:
   - label: "Triggering pipelines"
     plugins:
-      - monorepo-diff#v1.4.0:
+      - monorepo-diff#v1.5.0:
           diff: "git diff --name-only $(head -n 1 last_successful_build)"
           interpolation: false
           env:

go.sum

@@ -1,7 +1,3 @@
-github.com/bmatcuk/doublestar/v4 v4.8.1 h1:54Bopc5c2cAvhLRAzqOGCYHYyhcDHsFF4wWIR5wKP38=
-github.com/bmatcuk/doublestar/v4 v4.8.1/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc=
-github.com/bmatcuk/doublestar/v4 v4.9.0 h1:DBvuZxjdKkRP/dr4GVV4w2fnmrk5Hxc90T51LZjv0JA=
-github.com/bmatcuk/doublestar/v4 v4.9.0/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc=
 github.com/bmatcuk/doublestar/v4 v4.9.1 h1:X8jg9rRZmJd4yRy7ZeNDRnM+T3ZfHv15JiBJ/avrEXE=
 github.com/bmatcuk/doublestar/v4 v4.9.1/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc=
 github.com/buildkite/bintest/v3 v3.3.0 h1:RTWcSaJRlOT6t/K311ejPf+0J3LE/QEODzVG3vlLnWo=

pipeline_test.go

@@ -547,3 +547,36 @@ func TestGeneratePipelineWithNoStepsAndNoHooks(t *testing.T) {
 
 	assert.Equal(t, want, string(got))
 }
+
+func TestGeneratePipelineWithCondition(t *testing.T) {
+	steps := []Step{
+		{
+			Command:   "echo deploy to production",
+			Label:     "Deploy",
+			Condition: "build.branch == 'main' && build.pull_request.id == null",
+		},
+		{
+			Trigger:   "test-pipeline",
+			Condition: "build.message =~ /\\[deploy\\]/",
+		},
+	}
+
+	want := `steps:
+    - label: Deploy
+      if: build.branch == 'main' && build.pull_request.id == null
+      command: echo deploy to production
+    - trigger: test-pipeline
+      if: build.message =~ /\[deploy\]/
+`
+
+	plugin := Plugin{Wait: false}
+
+	pipeline, _, err := generatePipeline(steps, plugin)
+	require.NoError(t, err)
+	defer os.Remove(pipeline.Name())
+
+	got, err := os.ReadFile(pipeline.Name())
+	require.NoError(t, err)
+
+	assert.Equal(t, want, string(got))
+}

plugin.go

@@ -80,6 +80,7 @@ type Step struct {
 	Trigger   string                   `yaml:"trigger,omitempty"`
 	Label     string                   `yaml:"label,omitempty"`
 	Branches  string                   `yaml:"branches,omitempty"`
+	Condition string                   `json:"if,omitempty" yaml:"if,omitempty"`
 	Build     Build                    `yaml:"build,omitempty"`
 	Command   interface{}              `yaml:"command,omitempty"`
 	Commands  interface{}              `yaml:"commands,omitempty"`

plugin_test.go

@@ -824,3 +824,42 @@ func TestPluginLevelMetadataNotAppliedToCommandSteps(t *testing.T) {
 	assert.Equal(t, "echo Make Changes to Bin", commandStep.Command)
 	assert.Nil(t, commandStep.Build.Metadata, "Command step should not have metadata applied")
 }
+
+func TestPluginShouldPreserveStepCondition(t *testing.T) {
+	param := `[{
+		"github.com/buildkite-plugins/monorepo-diff-buildkite-plugin#commit": {
+			"watch": [
+				{
+					"path": "service/**/*",
+					"config": {
+						"command": "echo deploy",
+						"if": "build.branch == 'main' && build.pull_request.id == null"
+					}
+				}
+			]
+		}
+	}]`
+
+	got, err := initializePlugin(param)
+	assert.NoError(t, err)
+
+	expected := Plugin{
+		Diff:          "git diff --name-only HEAD~1",
+		Wait:          false,
+		LogLevel:      "info",
+		Interpolation: true,
+		Watch: []WatchConfig{
+			{
+				Paths: []string{"service/**/*"},
+				Step: Step{
+					Command:   "echo deploy",
+					Condition: "build.branch == 'main' && build.pull_request.id == null",
+				},
+			},
+		},
+	}
+
+	if diff := cmp.Diff(expected, got); diff != "" {
+		t.Fatalf("plugin diff (-want +got):\n%s", diff)
+	}
+}