bundle run: output update ID (#3331)

alyssa-db · web-flow · commit 6010f5642797 · 2025-08-01T06:28:40.000Z
## Changes To see which update was run, return updateID in the output. ## Why Necessary for showing summary of run in pipelines. ## Tests Updated bundle and pipelines tests to reflect new output. Sample output: Update ID: 2e522dc5-f817-46dc-b956-2e3e771d9ff3 update ID necessary for follow-up: #3332
diff --git a/acceptance/bundle/run/refresh-flags/output.txt b/acceptance/bundle/run/refresh-flags/output.txt
@@ -9,6 +9,7 @@ Deployment complete!
 >>> [CLI] bundle run my_pipeline --refresh table1,table2
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 
 >>> print_requests
 {
@@ -26,6 +27,7 @@ Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 >>> [CLI] bundle run my_pipeline --full-refresh-all
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 
 >>> print_requests
 {
@@ -40,6 +42,7 @@ Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 >>> [CLI] bundle run my_pipeline --full-refresh table1,table2
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 
 >>> print_requests
 {
@@ -57,6 +60,7 @@ Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 >>> [CLI] bundle run my_pipeline --full-refresh table1,table2 --refresh table3,table4
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 
 >>> print_requests
 {
diff --git a/acceptance/pipelines/dry-run/dry-run-pipeline/output.txt b/acceptance/pipelines/dry-run/dry-run-pipeline/output.txt
@@ -10,6 +10,7 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 >>> [PIPELINES] dry-run
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 {
   "body": {
     "validate_only": true
@@ -22,6 +23,7 @@ Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 >>> [PIPELINES] dry-run my_pipeline
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 {
   "body": {
     "validate_only": true
diff --git a/acceptance/pipelines/dry-run/no-wait/output.txt b/acceptance/pipelines/dry-run/no-wait/output.txt
@@ -10,4 +10,4 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 >>> [PIPELINES] dry-run --no-wait
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
-<EOL>
+Update ID: [UUID]
diff --git a/acceptance/pipelines/dry-run/no-wait/script b/acceptance/pipelines/dry-run/no-wait/script
@@ -1,5 +1,3 @@
 trace $PIPELINES deploy
 title "Dry running pipeline with --no-wait flag"
 trace $PIPELINES dry-run --no-wait
-# This printf is here to fix the whitespace linter error (ensures exactly one newline at end)
-printf "<EOL>\n"
diff --git a/acceptance/pipelines/dry-run/restart/output.txt b/acceptance/pipelines/dry-run/restart/output.txt
@@ -10,6 +10,7 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 >>> [PIPELINES] dry-run --restart
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 
 >>> print_requests
 {
diff --git a/acceptance/pipelines/e2e/output.txt b/acceptance/pipelines/e2e/output.txt
@@ -22,6 +22,7 @@ View your pipeline my_project_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o
 >>> [PIPELINES] run
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 
 === Edit project by creating and running a new second pipeline
 >>> [PIPELINES] deploy
@@ -58,6 +59,7 @@ View your pipeline my_project_pipeline_2 here: [DATABRICKS_URL]/pipelines/[UUID]
 >>> [PIPELINES] run my_project_pipeline_2
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 
 === Stop both pipelines before destroy
 >>> [PIPELINES] stop my_project_pipeline
diff --git a/acceptance/pipelines/run/no-wait/output.txt b/acceptance/pipelines/run/no-wait/output.txt
@@ -10,4 +10,4 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 >>> [PIPELINES] run --no-wait
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
-<EOL>
+Update ID: [UUID]
diff --git a/acceptance/pipelines/run/no-wait/script b/acceptance/pipelines/run/no-wait/script
@@ -1,5 +1,3 @@
 trace $PIPELINES deploy
 title "test --no-wait flag"
 trace $PIPELINES run --no-wait
-# This printf is here to fix the whitespace linter error (ensures exactly one newline at end)
-printf "<EOL>\n"
diff --git a/acceptance/pipelines/run/refresh-flags/output.txt b/acceptance/pipelines/run/refresh-flags/output.txt
@@ -10,6 +10,7 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 >>> [PIPELINES] run --refresh table1,table2
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 
 >>> print_requests
 {
@@ -27,6 +28,7 @@ Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 >>> [PIPELINES] run --full-refresh-all
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 
 >>> print_requests
 {
@@ -41,6 +43,7 @@ Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 >>> [PIPELINES] run --full-refresh table1,table2
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 
 >>> print_requests
 {
@@ -58,6 +61,7 @@ Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 >>> [PIPELINES] run --full-refresh table1,table2 --refresh table3,table4
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 
 >>> print_requests
 {
diff --git a/acceptance/pipelines/run/restart/output.txt b/acceptance/pipelines/run/restart/output.txt
@@ -10,6 +10,7 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 >>> [PIPELINES] run --restart
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 
 >>> print_requests
 {
diff --git a/acceptance/pipelines/run/run-pipeline/output.txt b/acceptance/pipelines/run/run-pipeline/output.txt
@@ -10,9 +10,10 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 >>> [PIPELINES] run
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 
 === Run pipeline with KEY, expect same output as without KEY
 >>> [PIPELINES] run my_pipeline
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
-<EOL>
+Update ID: [UUID]
diff --git a/acceptance/pipelines/run/run-pipeline/script b/acceptance/pipelines/run/run-pipeline/script
@@ -4,5 +4,3 @@ trace $PIPELINES run
 
 title "Run pipeline with KEY, expect same output as without KEY"
 trace $PIPELINES run my_pipeline
-# This printf is here to fix the whitespace linter error (ensures exactly one newline at end)
-printf "<EOL>\n"
diff --git a/acceptance/pipelines/stop/output.txt b/acceptance/pipelines/stop/output.txt
@@ -9,6 +9,7 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 >>> [PIPELINES] run
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
+Update ID: [UUID]
 
 === Stopping pipeline
 >>> [PIPELINES] stop
diff --git a/bundle/run/output/pipeline.go b/bundle/run/output/pipeline.go
@@ -0,0 +1,11 @@
+package output
+
+import "fmt"
+
+type PipelineOutput struct {
+	UpdateId string `json:"update_id"`
+}
+
+func (out *PipelineOutput) String() (string, error) {
+	return fmt.Sprintf("Update ID: %s\n", out.UpdateId), nil
+}
diff --git a/bundle/run/pipeline.go b/bundle/run/pipeline.go
@@ -115,7 +115,9 @@ func (r *pipelineRunner) Run(ctx context.Context, opts *Options) (output.RunOutp
 	progressLogger.Log(progress.NewPipelineUpdateUrlEvent(w.Config.Host, updateID, pipelineID))
 
 	if opts.NoWait {
-		return nil, nil
+		return &output.PipelineOutput{
+			UpdateId: updateID,
+		}, nil
 	}
 
 	// Poll update for completion and post status.
@@ -157,7 +159,9 @@ func (r *pipelineRunner) Run(ctx context.Context, opts *Options) (output.RunOutp
 		}
 		if state == pipelines.UpdateInfoStateCompleted {
 			log.Infof(ctx, "Update has completed successfully!")
-			return nil, nil
+			return &output.PipelineOutput{
+				UpdateId: updateID,
+			}, nil
 		}
 
 		time.Sleep(time.Second)

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ Deployment complete!`
`9`	`9`	`>>> [CLI] bundle run my_pipeline --refresh table1,table2`
`10`	`10`	`Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]`
`11`	`11`
	`12`	`+Update ID: [UUID]`
`12`	`13`
`13`	`14`	`>>> print_requests`
`14`	`15`	`{`
`@@ -26,6 +27,7 @@ Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]`
`26`	`27`	`>>> [CLI] bundle run my_pipeline --full-refresh-all`
`27`	`28`	`Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]`
`28`	`29`
	`30`	`+Update ID: [UUID]`
`29`	`31`
`30`	`32`	`>>> print_requests`
`31`	`33`	`{`
`@@ -40,6 +42,7 @@ Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]`
`40`	`42`	`>>> [CLI] bundle run my_pipeline --full-refresh table1,table2`
`41`	`43`	`Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]`
`42`	`44`
	`45`	`+Update ID: [UUID]`
`43`	`46`
`44`	`47`	`>>> print_requests`
`45`	`48`	`{`
`@@ -57,6 +60,7 @@ Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]`
`57`	`60`	`>>> [CLI] bundle run my_pipeline --full-refresh table1,table2 --refresh table3,table4`
`58`	`61`	`Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]`
`59`	`62`
	`63`	`+Update ID: [UUID]`
`60`	`64`
`61`	`65`	`>>> print_requests`
`62`	`66`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]`
`10`	`10`	`>>> [PIPELINES] dry-run`
`11`	`11`	`Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]`
`12`	`12`
	`13`	`+Update ID: [UUID]`
`13`	`14`	`{`
`14`	`15`	`"body": {`
`15`	`16`	`"validate_only": true`
`@@ -22,6 +23,7 @@ Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]`
`22`	`23`	`>>> [PIPELINES] dry-run my_pipeline`
`23`	`24`	`Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]`
`24`	`25`
	`26`	`+Update ID: [UUID]`
`25`	`27`	`{`
`26`	`28`	`"body": {`
`27`	`29`	`"validate_only": true`