Merge pull request #133 from toadzky/add-key-field-to-steps

feat: add support for `key` in watch config steps

Author: JoeColeman95

README.md

@@ -297,6 +297,23 @@ Default: `true`
 
 By setting `wait` to `true`, the build will wait until the triggered pipeline builds are successful before proceeding
 
+### `key` (optional)
+
+Add `key` to set the step or group key.
+
+```yaml
+steps:
+  - label: "Setting Key"
+    plugins:
+      - monorepo-diff#v1.5.2:
+          diff: "git diff --name-only HEAD~1"
+          watch:
+            - path: "bar-service/"
+              config:
+                key: echo-step
+                command: "echo deploy-bar"
+```
+
 ## Example
 
 ```yaml
@@ -317,6 +334,7 @@ steps:
               config:
                 command: "buildkite-agent pipeline upload ops/.buildkite/pipeline.yml"
                 label: "Upload pipeline"
+                key: pipeline-upload
                 # following configs are available in command. notify is not available in trigger step
                 notify:
                   - basecamp_campfire: https://basecamp-url

pipeline_test.go

@@ -665,3 +665,52 @@ func TestGeneratePipelineWithDependsOn(t *testing.T) {
 
 	assert.Equal(t, want, string(got))
 }
+
+func TestGeneratePipelineWithStepKey(t *testing.T) {
+	steps := []Step{
+		{
+			Command: "echo build",
+			Label:   "Build",
+			Key:     "build-step",
+		},
+		{
+			Command:   "echo test",
+			Label:     "Test",
+			Key:       "test-step",
+			DependsOn: "build-step",
+		},
+		{
+			Trigger:   "deploy-pipeline",
+			DependsOn: []interface{}{"build-step", "test-step"},
+		},
+	}
+
+	want := `steps:
+    - label: Build
+      command: echo build
+      key: build-step
+    - label: Test
+      command: echo test
+      depends_on: build-step
+      key: test-step
+    - trigger: deploy-pipeline
+      depends_on:
+        - build-step
+        - test-step
+`
+
+	plugin := Plugin{Wait: false}
+
+	pipeline, _, err := generatePipeline(steps, plugin)
+	require.NoError(t, err)
+	defer func() {
+		if err = os.Remove(pipeline.Name()); err != nil {
+			t.Logf("Failed to remove temporary pipeline file: %v", err)
+		}
+	}()
+
+	got, err := os.ReadFile(pipeline.Name())
+	require.NoError(t, err)
+
+	assert.Equal(t, want, string(got))
+}

plugin.go

@@ -94,6 +94,7 @@ type Step struct {
 	RawNotify []map[string]interface{} `json:"notify" yaml:",omitempty"`
 	Notify    []StepNotify             `yaml:"notify,omitempty"`
 	DependsOn interface{}              `json:"depends_on" yaml:"depends_on,omitempty"`
+	Key       string                   `yaml:"key,omitempty"`
 	Steps     []Step                   `yaml:"steps,omitempty"`
 }
 

plugin.yml

@@ -42,6 +42,8 @@ configuration:
         config:
           type: object
           properties:
+            key: 
+              type: string
             command:
               type: string
             trigger: