refactor: rename onError to on_error in YAML, added example

Author: hlubek

definition/pipelines.go

@@ -72,15 +72,15 @@ type PipelineDef struct {
 	// Tasks is a map of task names to task definitions
 	Tasks map[string]TaskDef `yaml:"tasks"`
 
-	// Task to be executed if this pipeline fails, e.g. for notifications.
+	// Task to be added and executed if this pipeline fails, e.g. for notifications.
 	//
 	// In this task, you have the following variables set:
 	// - failedTaskName: Name of the failed task (key from pipelines.yml)
 	// - failedTaskExitCode: Exit code of the failed task
 	// - failedTaskError: Error message of the failed task
 	// - failedTaskStdout: Stdout of the failed task
 	// - failedTaskStderr: Stderr of the failed task
-	OnError *OnErrorTaskDef `yaml:"onError"`
+	OnError *OnErrorTaskDef `yaml:"on_error"`
 
 	// SourcePath stores the source path where the pipeline was defined
 	SourcePath string

examples/pipelines.yml

@@ -60,6 +60,9 @@ pipelines:
       no-work:
         script:
           - go for a walk
+    on_error:
+      script:
+        - echo "Something went wrong, let's handle the error from {{.failedTaskName}}"
 
   queue_it:
     concurrency: 2

prunner_test.go

@@ -294,7 +294,7 @@ Failed Task Stderr: This message goes to stderr
 
 	jt := job.Tasks.ByName("on_error")
 	if assert.NotNil(t, jt) {
-		assert.False(t, jt.Canceled, "onError task was not marked as canceled")
+		assert.False(t, jt.Canceled, "on_error task was not marked as canceled")
 		assert.False(t, jt.Errored, "task was not marked as errored")
 		assert.Equal(t, "done", jt.Status, "task has status done")
 		assert.Nil(t, jt.Error, "task has no error set")
@@ -353,7 +353,7 @@ func TestPipelineRunner_ScheduleAsync_WithFailingScript_TriggersOnErrorHook_AndS
 
 	jt := job.Tasks.ByName("on_error")
 	if assert.NotNil(t, jt) {
-		assert.False(t, jt.Canceled, "onError task was not marked as canceled")
+		assert.False(t, jt.Canceled, "on_error task was not marked as canceled")
 		assert.True(t, jt.Errored, "task was not marked as errored")
 		assert.Equal(t, "error", jt.Status, "task has status done")
 		assert.NotNil(t, jt.Error, "task has no error set")
@@ -412,7 +412,7 @@ func TestPipelineRunner_ScheduleAsync_WithFailingScript_TriggersOnErrorHook_AndS
 
 	jt := job.Tasks.ByName("on_error")
 	if assert.NotNil(t, jt) {
-		assert.False(t, jt.Canceled, "onError task was not marked as canceled")
+		assert.False(t, jt.Canceled, "on_error task was not marked as canceled")
 		assert.True(t, jt.Errored, "task was not marked as errored")
 		assert.Equal(t, "error", jt.Status, "task has status done")
 		assert.NotNil(t, jt.Error, "task has no error set")