From 65c8f1317a9480fea7d2fa9998d1ce7a261da310 Mon Sep 17 00:00:00 2001
From: Luke Kysow <1034429+lkysow@users.noreply.github.com>
Date: Tue, 5 Mar 2019 13:32:08 -0500
Subject: [PATCH] Give warning for common error missing 'run' key

---
 server/events/yaml/raw/stage_test.go    | 2 +-
 server/events/yaml/raw/step.go          | 2 +-
 server/events/yaml/raw/step_test.go     | 2 +-
 server/events/yaml/raw/workflow_test.go | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/server/events/yaml/raw/stage_test.go b/server/events/yaml/raw/stage_test.go
index 245ed2c4f..240133baa 100644
--- a/server/events/yaml/raw/stage_test.go
+++ b/server/events/yaml/raw/stage_test.go
@@ -58,7 +58,7 @@ func TestStage_Validate(t *testing.T) {
 		},
 	}
 	validation.ErrorTag = "yaml"
-	ErrEquals(t, "steps: (0: \"invalid\" is not a valid step type.).", s.Validate())
+	ErrEquals(t, "steps: (0: \"invalid\" is not a valid step type, maybe you omitted the 'run' key.).", s.Validate())
 
 	// Empty steps should validate.
 	Ok(t, (raw.Stage{}).Validate())
diff --git a/server/events/yaml/raw/step.go b/server/events/yaml/raw/step.go
index b095f6008..e55e89269 100644
--- a/server/events/yaml/raw/step.go
+++ b/server/events/yaml/raw/step.go
@@ -83,7 +83,7 @@ func (s Step) Validate() error {
 	validStep := func(value interface{}) error {
 		str := *value.(*string)
 		if str != InitStepName && str != PlanStepName && str != ApplyStepName {
-			return fmt.Errorf("%q is not a valid step type", str)
+			return fmt.Errorf("%q is not a valid step type, maybe you omitted the 'run' key", str)
 		}
 		return nil
 	}
diff --git a/server/events/yaml/raw/step_test.go b/server/events/yaml/raw/step_test.go
index ec8a5d493..32e040305 100644
--- a/server/events/yaml/raw/step_test.go
+++ b/server/events/yaml/raw/step_test.go
@@ -216,7 +216,7 @@ func TestStep_Validate(t *testing.T) {
 			input: raw.Step{
 				Key: String("invalid"),
 			},
-			expErr: "\"invalid\" is not a valid step type",
+			expErr: "\"invalid\" is not a valid step type, maybe you omitted the 'run' key",
 		},
 		{
 			description: "multiple keys in map",
diff --git a/server/events/yaml/raw/workflow_test.go b/server/events/yaml/raw/workflow_test.go
index 85320cfaa..fbf757226 100644
--- a/server/events/yaml/raw/workflow_test.go
+++ b/server/events/yaml/raw/workflow_test.go
@@ -104,7 +104,7 @@ func TestWorkflow_Validate(t *testing.T) {
 		},
 	}
 	validation.ErrorTag = "yaml"
-	ErrEquals(t, "apply: (steps: (0: \"invalid\" is not a valid step type.).).", w.Validate())
+	ErrEquals(t, "apply: (steps: (0: \"invalid\" is not a valid step type, maybe you omitted the 'run' key.).).", w.Validate())
 
 	// Unset keys should validate.
 	Ok(t, (raw.Workflow{}).Validate())