Include variable locations in --include-locations output by petrapostelnicu-db · Pull Request #7351 · databricks/cli

petrapostelnicu-db · 2026-11-04T15:37:51Z

The location map that bundle validate and bundle summary emit with --include-locations now covers variables:

variables.: where the variable is declared.
variables..value: where the resolved value comes from, such as a target override or .databricks/bundle//variable-overrides.json. It is absent when the value has no file, as with --var, BUNDLE_VAR_*, and lookups.

The workspace UI uses this to link each variable to its file in the deployments modal.

The location map that `bundle validate` and `bundle summary` emit with --include-locations now covers variables: - variables.<name>: where the variable is declared. - variables.<name>.value: where the resolved value comes from, such as a target override or .databricks/bundle/<target>/variable-overrides.json. It is absent when the value has no file, as with --var, BUNDLE_VAR_*, and lookups. The workspace UI uses this to link each variable to its file. Co-authored-by: Isaac <no-reply@databricks.com>

github-actions · 2026-11-04T15:45:37Z

Commit: f969f68e6 | Workflow run

Regression test report

Selected 1 changed tests (limit=20, 0 not selected)

2 tests: regression=2 unreleased=0 coverage=0 failing=0

test	branch	main (`663e1f7`)	latest (v1.24.0)
TestAccept/bundle/variables/locations/DMS=	✅	❌	❌
TestAccept/bundle/variables/locations/DMS=true	✅	❌	❌

TestAccept/bundle/variables/locations/DMS=: branch ✅ | main (663e1f7) ❌ | latest (v1.24.0) ❌

main (663e1f7):

acceptance_test.go:1345: Diff:
        --- bundle/variables/locations/output.txt
        +++ /tmp/TestAcceptbundlevariableslocationsDMS=2855894031/002/output.txt
        @@ -24,72 +24,5 @@
           "variables": [
             "databricks.yml:9:3",
             "variables/shared.yml:2:3"
        -  ],
        -  "variables.complex_var": [
        -    "databricks.yml:18:5"
        -  ],
        -  "variables.complex_var.value": [
        -    "databricks.yml:43:9"
        -  ],
        -  "variables.dash-name": [
        -    "databricks.yml:30:5"
        -  ],
        -  "variables.dash-name.value": [
        -    "databricks.yml:30:14"
        -  ],
        -  "variables.from_cli": [
        -    "databricks.yml:12:5"
        -  ],
        -  "variables.from_env": [
        -    "databricks.yml:14:5"
        -  ],
        -  "variables.from_file": [
        -    "databricks.yml:16:5"
        -  ],
        -  "variables.from_file.value": [
        -    ".databricks/bundle/dev/variable-overrides.json:2:28"
        -  ],
        -  "variables.included": [
        -    "variables/shared.yml:3:5"
        -  ],
        -  "variables.included.value": [
        -    "targets.yml:4:17"
        -  ],
        -  "variables.lookup_overridden": [
        -    "databricks.yml:32:5"
        -  ],
        -  "variables.lookup_overridden.value": [
        -    "databricks.yml:44:26"
        -  ],
        -  "variables.override_full": [
        -    "databricks.yml:26:5"
        -  ],
        -  "variables.override_full.value": [
        -    "databricks.yml:41:18"
        -  ],
        -  "variables.override_short": [
        -    "databricks.yml:24:5"
        -  ],
        -  "variables.override_short.value": [
        -    "databricks.yml:39:23"
        -  ],
        -  "variables.simple": [
        -    "databricks.yml:10:5"
        -  ],
        -  "variables.simple.value": [
        -    "databricks.yml:10:14"
        -  ],
        -  "variables.split": [
        -    "databricks.yml:28:5",
        -    "variables/shared.yml:5:5"
        -  ],
        -  "variables.split.value": [
        -    "variables/shared.yml:5:14"
        -  ],
        -  "variables.var_in_var": [
        -    "databricks.yml:22:5"
        -  ],
        -  "variables.var_in_var.value": [
        -    "databricks.yml:22:14"
           ]
         }
        
FAIL

latest (v1.24.0): same output as main (663e1f7)

TestAccept/bundle/variables/locations/DMS=true: branch ✅ | main (663e1f7) ❌ | latest (v1.24.0) ❌

main (663e1f7):

acceptance_test.go:1345: Diff:
        --- bundle/variables/locations/output.txt
        +++ /tmp/TestAcceptbundlevariableslocationsDMS=true3555543991/002/output.txt
        @@ -24,72 +24,5 @@
           "variables": [
             "databricks.yml:9:3",
             "variables/shared.yml:2:3"
        -  ],
        -  "variables.complex_var": [
        -    "databricks.yml:18:5"
        -  ],
        -  "variables.complex_var.value": [
        -    "databricks.yml:43:9"
        -  ],
        -  "variables.dash-name": [
        -    "databricks.yml:30:5"
        -  ],
        -  "variables.dash-name.value": [
        -    "databricks.yml:30:14"
        -  ],
        -  "variables.from_cli": [
        -    "databricks.yml:12:5"
        -  ],
        -  "variables.from_env": [
        -    "databricks.yml:14:5"
        -  ],
        -  "variables.from_file": [
        -    "databricks.yml:16:5"
        -  ],
        -  "variables.from_file.value": [
        -    ".databricks/bundle/dev/variable-overrides.json:2:28"
        -  ],
        -  "variables.included": [
        -    "variables/shared.yml:3:5"
        -  ],
        -  "variables.included.value": [
        -    "targets.yml:4:17"
        -  ],
        -  "variables.lookup_overridden": [
        -    "databricks.yml:32:5"
        -  ],
        -  "variables.lookup_overridden.value": [
        -    "databricks.yml:44:26"
        -  ],
        -  "variables.override_full": [
        -    "databricks.yml:26:5"
        -  ],
        -  "variables.override_full.value": [
        -    "databricks.yml:41:18"
        -  ],
        -  "variables.override_short": [
        -    "databricks.yml:24:5"
        -  ],
        -  "variables.override_short.value": [
        -    "databricks.yml:39:23"
        -  ],
        -  "variables.simple": [
        -    "databricks.yml:10:5"
        -  ],
        -  "variables.simple.value": [
        -    "databricks.yml:10:14"
        -  ],
        -  "variables.split": [
        -    "databricks.yml:28:5",
        -    "variables/shared.yml:5:5"
        -  ],
        -  "variables.split.value": [
        -    "variables/shared.yml:5:14"
        -  ],
        -  "variables.var_in_var": [
        -    "databricks.yml:22:5"
        -  ],
        -  "variables.var_in_var.value": [
        -    "databricks.yml:22:14"
           ]
         }

latest (v1.24.0): same output as main (663e1f7)

eng-dev-ecosystem-bot · 2026-11-04T16:06:03Z

✅ Integration test report

Commit: f969f68

Run: 42218836155

	Env	✅pass	🙈skip	Time
✅	aws linux-2core-8gb	271	16	5:19
✅	aws-windows-latest-4core-16gb	273	14	3:27
✅	azure linux-2core-8gb	270	16	4:22
✅	azure-windows-latest-4core-16gb	272	14	3:40
✅	gcp linux-2core-8gb	271	16	4:43
✅	gcp-windows-latest-4core-16gb	273	14	3:10

Top 3 slowest tests (at least 2 minutes):

duration	env	testname
3:11	aws-windows-latest-4core-16gb	TestAccept
3:05	gcp-windows-latest-4core-16gb	TestAccept
3:03	azure-windows-latest-4core-16gb	TestAccept

andrewnester · 2026-11-06T11:08:48Z

 		dyn.NewPattern(dyn.Key("resources"), dyn.Key("jobs"), dyn.AnyKey(), dyn.Key("tasks")),                 // Job tasks ("resources.jobs.my_job.tasks")
 		dyn.NewPattern(dyn.Key("resources"), dyn.Key("jobs"), dyn.AnyKey(), dyn.Key("tasks"), dyn.AnyIndex()), // Job task items ("resources.jobs.my_job.tasks[2]")
+		dyn.NewPattern(dyn.Key("variables"), dyn.AnyKey()),                                                    // Variable definitions ("variables.my_var")
+		dyn.NewPattern(dyn.Key("variables"), dyn.AnyKey(), dyn.Key("value")),                                  // Resolved variable values ("variables.my_var.value")


Should this get a .nextchanges/bundles/ entry? The last --include-locations change (#7185) has one in the changelog, and the UI side will want to know which CLI version ships the variable keys.

andrewnester · 2026-11-06T11:08:48Z

@@ -0,0 +1,10 @@
+[[Server]]
+Pattern = "GET /api/2.0/preview/scim/v2/ServicePrincipals"


This is the same stub as in variables/lookup/test.toml, and issue_3039_lookup_with_ref carries a third variant. Maybe time to add a ServicePrincipals handler to libs/testserver instead, like .agents/rules/testing.md asks?

you're right. i removed the variable and the stub instead, I think adding service principals handler should be a separate pr. in my case, it wasn't needed, the variable with no value location test case is already covered by from_cli

andrewnester · 2026-11-06T11:08:48Z

+    "databricks.yml:18:5"
+  ],
+  "variables.complex_var.value": [
+    "databricks.yml:46:9"


Is it expected that the complex value points at the first key inside the override (46:9) rather than the override itself (complex_var: at 45:7)? Probably fine if the UI only needs a line to link to, just checking it's intentional.

yes, it is intentional (kept consistent with resources ) and the ui only needs to link the file

## Release v1.25.0 ### CLI * `databricks aitools install --output json` now reports a more specific `error_category` (`MANIFEST_NOT_FOUND`, `PERMISSION_DENIED`, `FILESYSTEM`) for some failures it reported as `UNCATEGORIZED`. ([#7380](#7380)) * Suggest `databricks auth logout --profile <profile-name> --delete` when multiple profiles match the same workspace in `databricks auth docker` commands. ([#7363](#7363)) * Fix `%pip` in Jupyter notebooks opened over `databricks ssh connect` on serverless environment versions 5 and 6 and on dedicated clusters running recent Databricks Runtime versions, which fell back to the stock IPython magic instead of the Databricks one. ([#7263](#7263)) ### AI Runtime * `databricks air run` now validates the config server-side while it uploads the run artifacts, instead of before, which shortens submission. ([#7368](#7368)) * Remove `CRITICAL` as a valid `compute.priority_class` value; the AI Runtime API no longer accepts it. ([#7371](#7371)) ### Bundles * Built-in templates add the workspace ID to `workspace.host` (`?w=<id>`) when the profile or an environment variable sets it, so generated bundles select the right workspace on hosts shared by several workspaces. Welcome messages show the same URL, and `dbt-sql` also adds `?o=<id>` to the HTTP path it suggests for `dbt init`. ([#7350](#7350)) * Fix grants of a renamed or recreated catalog, schema, volume or other UC resource staying recorded under the old name, which made the next `bundle plan` propose to apply them again. ([#7345](#7345)) * Fix permissions of a recreated pipeline, app, dashboard, model serving endpoint or other resource staying recorded under the old ID, which made every later `bundle plan` propose to apply them again. ([#7361](#7361)) * Add the `postgres_data_apis` resource (Private Preview) for enabling and configuring the Data API of a Lakebase Postgres database. ([#7160](#7160)) * Fixes [#4012](#4012): registered model `aliases` are now set in Unity Catalog on deploy instead of being silently ignored. A model without an `aliases` section keeps the aliases set outside the bundle (for example by MLflow), and `aliases: []` removes them. ([#7163](#7163)) * Include variable declarations and the source of each resolved value in the `--include-locations` output of `bundle validate` and `bundle summary`. ([#7351](#7351)) * Add `.workspace.URLID` to bundle templates: the workspace ID that `.workspace.URL` adds, or empty, so templates can use it without failing when the ID is unknown. ([#7388](#7388)) * Expose the workspace of the selected profile to bundle templates as `.workspace`, with `Hostname`, `ID`, and `URL`, so templates can address a workspace on a host shared by several workspaces. A template input named `workspace` takes precedence. ([#7349](#7349)) ### Dependency Updates * Bump dependencies with known vulnerabilities. ([#7394](#7394)) * Upgrade `github.com/mattn/go-runewidth` to v0.0.31, which removes ~30ms of startup time from every command. ([#7391](#7391)) * Update the Go SDK to [v0.194.0](https://github.com/databricks/databricks-sdk-go/releases/tag/v0.194.0). ([#7371](#7371)) * Update the Go SDK to [v0.195.0](https://github.com/databricks/databricks-sdk-go/releases/tag/v0.195.0). ([#7384](#7384))

petrapostelnicu-db requested review from a team as code owners November 4, 2026 15:37

petrapostelnicu-db requested a review from shreyas-goenka November 4, 2026 15:37

github-actions Bot added the DABs DABs related issues label Nov 4, 2026

Merge branch 'main' into variable-locations

6ad6ac2

andrewnester reviewed Nov 6, 2026

View reviewed changes

fix comments

f969f68

petrapostelnicu-db requested a review from andrewnester November 6, 2026 12:43

andrewnester approved these changes Nov 9, 2026

View reviewed changes

petrapostelnicu-db added this pull request to the merge queue Nov 9, 2026

Merged via the queue into main with commit 21f0967 Nov 9, 2026
28 checks passed

petrapostelnicu-db deleted the variable-locations branch November 9, 2026 09:37

rugpanov mentioned this pull request Nov 9, 2026

Update Databricks CLI to v1.25.0 databricks/databricks-vscode#2292

Open

Navigation Menu

Repository navigation

Include variable locations in --include-locations output - #7351

Include variable locations in --include-locations output#7351
petrapostelnicu-db merged 3 commits into
mainfrom
variable-locations

petrapostelnicu-db commented Nov 4, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Nov 4, 2026 •

edited

Loading

Uh oh!

eng-dev-ecosystem-bot commented Nov 4, 2026 •

edited

Loading

Uh oh!

andrewnester Nov 6, 2026

Uh oh!

andrewnester Nov 6, 2026

Uh oh!

petrapostelnicu-db Nov 6, 2026

Uh oh!

andrewnester Nov 6, 2026

Uh oh!

petrapostelnicu-db Nov 6, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -0,0 +1,10 @@
		[[Server]]
		Pattern = "GET /api/2.0/preview/scim/v2/ServicePrincipals"

Conversation

petrapostelnicu-db commented Nov 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Nov 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Regression test report

Uh oh!

eng-dev-ecosystem-bot commented Nov 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Integration test report

Uh oh!

andrewnester Nov 6, 2026

Choose a reason for hiding this comment

Uh oh!

andrewnester Nov 6, 2026

Choose a reason for hiding this comment

Uh oh!

petrapostelnicu-db Nov 6, 2026

Choose a reason for hiding this comment

Uh oh!

andrewnester Nov 6, 2026

Choose a reason for hiding this comment

Uh oh!

petrapostelnicu-db Nov 6, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

petrapostelnicu-db commented Nov 4, 2026 •

edited

Loading

github-actions Bot commented Nov 4, 2026 •

edited

Loading

eng-dev-ecosystem-bot commented Nov 4, 2026 •

edited

Loading