pipelines: suggest 'pipelines deploy' in run/dry-run (#4277)

kanterov · web-flow · commit 6b7a7f8347f9 · 2026-01-14T10:53:42.000Z
## Changes
Add recommendation suggesting to call 'pipelines deploy' before 'run'
and 'dry-run':
```
$ databricks pipelines dry-run
Recommendation: This command runs the last deployed version of the code

If you've made local changes, run 'databricks pipelines deploy' first to ensure they are included.
```

The suggestion is different depending on which entrypoint is used
suggesting to use either "databricks pipelines" or just "pipelines".

## Why
It's a common pitfall, and we haven't yet implemented an option to do
deployment automatically.

## Tests
Existing acceptance tests
diff --git a/acceptance/pipelines/dry-run/dry-run-pipeline/output.txt b/acceptance/pipelines/dry-run/dry-run-pipeline/output.txt
@@ -8,6 +8,10 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 
 === Dry running pipeline, should have validate_only set to true
 >>> [ENTRYPOINT] dry-run
+Recommendation: This command runs the last deployed version of the code
+
+If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included.
+
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 Update ID: [UUID]
@@ -21,6 +25,10 @@ Update ID: [UUID]
 
 === Dry running pipeline with KEY, expect same output as without KEY
 >>> [ENTRYPOINT] dry-run my_pipeline
+Recommendation: This command runs the last deployed version of the code
+
+If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included.
+
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 Update ID: [UUID]
diff --git a/acceptance/pipelines/dry-run/no-wait/output.txt b/acceptance/pipelines/dry-run/no-wait/output.txt
@@ -8,6 +8,10 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 
 === Dry running pipeline with --no-wait flag
 >>> [ENTRYPOINT] dry-run --no-wait
+Recommendation: This command runs the last deployed version of the code
+
+If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included.
+
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 Update ID: [UUID]
diff --git a/acceptance/pipelines/dry-run/restart/output.txt b/acceptance/pipelines/dry-run/restart/output.txt
@@ -8,6 +8,10 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 
 === Dry running pipeline with --restart flag, should stop the current pipeline and start a new run
 >>> [ENTRYPOINT] dry-run --restart
+Recommendation: This command runs the last deployed version of the code
+
+If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included.
+
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 Update ID: [UUID]
diff --git a/acceptance/pipelines/e2e/output.txt b/acceptance/pipelines/e2e/output.txt
@@ -25,6 +25,10 @@ View your pipeline lakeflow_project_etl here: [DATABRICKS_URL]/pipelines/[UUID]?
 
 === Run pipeline
 >>> [PIPELINES] run
+Recommendation: This command runs the last deployed version of the code
+
+If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included.
+
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 Update ID: [UUID]
@@ -71,6 +75,10 @@ View your pipeline lakeflow_project_etl_2 here: [DATABRICKS_URL]/pipelines/[UUID
 }
 
 >>> [PIPELINES] run lakeflow_project_etl_2
+Recommendation: This command runs the last deployed version of the code
+
+If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included.
+
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 Update ID: [UUID]
diff --git a/acceptance/pipelines/run/no-wait/output.txt b/acceptance/pipelines/run/no-wait/output.txt
@@ -8,6 +8,10 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 
 === test --no-wait flag
 >>> [ENTRYPOINT] run --no-wait
+Recommendation: This command runs the last deployed version of the code
+
+If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included.
+
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 Update ID: [UUID]
diff --git a/acceptance/pipelines/run/refresh-flags/output.txt b/acceptance/pipelines/run/refresh-flags/output.txt
@@ -8,6 +8,10 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 
 === Running pipeline with --refresh flag and specific tables
 >>> [ENTRYPOINT] run --refresh table1,table2
+Recommendation: This command runs the last deployed version of the code
+
+If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included.
+
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 Update ID: [UUID]
@@ -31,6 +35,10 @@ Pipeline configurations for this update:
 
 === Running pipeline with --full-refresh-all flag
 >>> [ENTRYPOINT] run --full-refresh-all
+Recommendation: This command runs the last deployed version of the code
+
+If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included.
+
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 Update ID: [UUID]
@@ -51,6 +59,10 @@ Pipeline configurations for this update:
 
 === Running pipeline with --full-refresh flag and specific tables
 >>> [ENTRYPOINT] run --full-refresh table1,table2
+Recommendation: This command runs the last deployed version of the code
+
+If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included.
+
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 Update ID: [UUID]
@@ -74,6 +86,10 @@ Pipeline configurations for this update:
 
 === Running pipeline with --full-refresh flag and --refresh flag
 >>> [ENTRYPOINT] run --full-refresh table1,table2 --refresh table3,table4
+Recommendation: This command runs the last deployed version of the code
+
+If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included.
+
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 Update ID: [UUID]
diff --git a/acceptance/pipelines/run/restart/output.txt b/acceptance/pipelines/run/restart/output.txt
@@ -8,6 +8,10 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 
 === Running pipeline with --restart flag
 >>> [ENTRYPOINT] run --restart
+Recommendation: This command runs the last deployed version of the code
+
+If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included.
+
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 Update ID: [UUID]
diff --git a/acceptance/pipelines/run/run-info/output.txt b/acceptance/pipelines/run/run-info/output.txt
@@ -8,6 +8,10 @@ View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 
 === Run pipeline and display pipeline configuration summary and events durations
 >>> [ENTRYPOINT] run
+Recommendation: This command runs the last deployed version of the code
+
+If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included.
+
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/test-update-123
 
 [TIMESTAMP] update_progress  "Update test-update-123 is COMPLETED."
diff --git a/acceptance/pipelines/stop/output.txt b/acceptance/pipelines/stop/output.txt
@@ -7,6 +7,10 @@ Deployment complete!
 View your pipeline my_pipeline here: [DATABRICKS_URL]/pipelines/[UUID]?o=[NUMID]
 
 >>> [ENTRYPOINT] run
+Recommendation: This command runs the last deployed version of the code
+
+If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included.
+
 Update URL: [DATABRICKS_URL]/#joblist/pipelines/[UUID]/updates/[UUID]
 
 Update ID: [UUID]
diff --git a/acceptance/pipelines/test.toml b/acceptance/pipelines/test.toml
@@ -1,3 +1,11 @@
 # All pipelines tests are local only
 Local = true
 Cloud = false
+
+[[Repls]]
+Old = "If you've made local changes, run 'pipelines deploy' first to ensure they are included"
+New = "If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included"
+
+[[Repls]]
+Old = "If you've made local changes, run 'databricks pipelines deploy' first to ensure they are included"
+New = "If you've made local changes, run '[DEPLOYCMD]' first to ensure they are included"
diff --git a/cmd/pipelines/dry_run.go b/cmd/pipelines/dry_run.go
@@ -32,13 +32,18 @@ If there is only one pipeline in the project, KEY is optional and the pipeline w
 	cmd.Flags().BoolVar(&restart, "restart", false, "Restart the run if it is already running.")
 
 	cmd.RunE = func(cmd *cobra.Command, args []string) error {
+		ctx := logdiag.InitContext(cmd.Context())
+		cmd.SetContext(ctx)
+
 		b, err := utils.ProcessBundle(cmd, utils.ProcessOptions{
 			ErrorOnEmptyState: true,
+			SkipInitContext:   true,
 		})
 		if err != nil {
 			return err
 		}
-		ctx := cmd.Context()
+
+		suggestPipelineDeploy(ctx, cmd)
 
 		key, _, err := resolveRunArgument(ctx, b, args)
 		if err != nil {
diff --git a/cmd/pipelines/run.go b/cmd/pipelines/run.go
@@ -253,6 +253,9 @@ Refreshes all tables in the pipeline unless otherwise specified.`,
 	cmd.Flags().BoolVar(&restart, "restart", false, "Restart the run if it is already running.")
 
 	cmd.RunE = func(cmd *cobra.Command, args []string) error {
+		ctx := logdiag.InitContext(cmd.Context())
+		cmd.SetContext(ctx)
+
 		var key string
 		b, err := utils.ProcessBundle(cmd, utils.ProcessOptions{
 			PostInitFunc: func(ctx context.Context, b *bundle.Bundle) error {
@@ -261,11 +264,13 @@ Refreshes all tables in the pipeline unless otherwise specified.`,
 				return err
 			},
 			ErrorOnEmptyState: true,
+			SkipInitContext:   true,
 		})
 		if err != nil {
 			return err
 		}
-		ctx := cmd.Context()
+
+		suggestPipelineDeploy(ctx, cmd)
 
 		runner, err := keyToRunner(b, key)
 		if err != nil {
diff --git a/cmd/pipelines/utils.go b/cmd/pipelines/utils.go
@@ -13,9 +13,12 @@ import (
 	"github.com/databricks/cli/bundle/resources"
 	"github.com/databricks/cli/bundle/run"
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/diag"
+	"github.com/databricks/cli/libs/logdiag"
 	databricks "github.com/databricks/databricks-sdk-go"
 	"github.com/databricks/databricks-sdk-go/client"
 	"github.com/databricks/databricks-sdk-go/service/pipelines"
+	"github.com/spf13/cobra"
 )
 
 // Copied from cmd/bundle/run.go
@@ -341,3 +344,17 @@ func isPipeline(ref resources.Reference) bool {
 		return false
 	}
 }
+
+func suggestPipelineDeploy(ctx context.Context, cmd *cobra.Command) {
+	deployCmd := cmd.Parent().CommandPath() + " deploy"
+	diags := diag.Recommendationf(
+		`This command runs the last deployed version of the code
+
+If you've made local changes, run '%s' first to ensure they are included.`,
+		deployCmd,
+	)
+
+	for _, el := range diags {
+		logdiag.LogDiag(ctx, el)
+	}
+}
