Repository navigation
Expose the workspace context to bundle templates as .workspace - #7349
Merged
Merged
Conversation
Contributor
|
Commit: Regression test reportSelected 2 changed tests (limit=20, 0 not selected) 4 tests: regression=4 unreleased=0 coverage=0 failing=0
TestAccept/bundle/templates-machinery/workspace_variable/input/DMS=: branch ✅ | main (eb1328d) ❌ | latest (v1.24.0) ❌main (eb1328d): latest (v1.24.0): TestAccept/bundle/templates-machinery/workspace_variable/input/DMS=true: branch ✅ | main (eb1328d) ❌ | latest (v1.24.0) ❌main (eb1328d): latest (v1.24.0): same output as main (eb1328d) TestAccept/bundle/templates-machinery/workspace_variable/runtime/DMS=: branch ✅ | main (eb1328d) ❌ | latest (v1.24.0) ❌main (eb1328d): latest (v1.24.0): same output as main (eb1328d) TestAccept/bundle/templates-machinery/workspace_variable/runtime/DMS=true: branch ✅ | main (eb1328d) ❌ | latest (v1.24.0) ❌main (eb1328d): latest (v1.24.0): |
Templates get the workspace of the selected profile as .workspace, in template files and in schema rendering. It has Hostname, ID and URL. URL adds ?w=<id> when a profile, an environment variable, or the bundle in the working directory sets the workspace ID, so that a host shared by several workspaces selects the right one. An ID that the SDK resolved from host metadata is not added, so the host still matches a profile without workspace_id under strict profile matching. ID fails when the ID is unknown, and doesn't make a request to find it. A workspace input declared in the schema takes precedence. Co-authored-by: Isaac <no-reply@databricks.com>
pavloKozlov
force-pushed
the
workspace-context-template-data
branch
from
November 4, 2026 15:41
b931f85 to
5f2f6db
Compare
Collaborator
✅ Integration test reportCommit: ea56a04
Top 3 slowest tests (at least 2 minutes):
|
Strict profile matching compares the workspace ID in the bundle host with the profile's workspace_id and doesn't read it from an adb-<id> hostname. Without ?w=, a profile with workspace_id on such a host didn't match the generated host. URL no longer uses workspaceurls.WorkspaceBaseURL, which skips ?w= there, so that package is unchanged. Co-authored-by: Isaac <no-reply@databricks.com>
RenderSchema skipped a property when the input file had a value for it, so its default came back as template text. A caller that renders the schema again with the current inputs got, for example, the raw .workspace.URL expression. The default is now rendered, and the input value is still the one used for the following properties. Co-authored-by: Isaac <no-reply@databricks.com>
Hostname is now the host name only, without the port, like url.URL.Hostname. Databricks hosts don't have an explicit port, so this changes nothing for them. Co-authored-by: Isaac <no-reply@databricks.com>
This reverts 51344db. Templates that strip the scheme from workspace_host get host:port, so keeping the port gives them the same value with .workspace.Hostname. Databricks hosts don't have an explicit port, so for them both are the same. Co-authored-by: Isaac <no-reply@databricks.com>
denik
approved these changes
Nov 6, 2026
deco-sdk-tagging Bot
added a commit
that referenced
this pull request
Nov 9, 2026
## 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))
idelafuente-oc
pushed a commit
to idelafuente-oc/cli
that referenced
this pull request
Nov 11, 2026
…s#7388) ## Changes Adds `.workspace.URLID`: the workspace ID that `.workspace.URL` adds as `?w=`, or empty. Unlike `.workspace.ID`, it doesn't fail when the ID is unknown and doesn't return an ID from host metadata, so templates can use it for optional parts such as the `?o=` that dbt needs. Schema rendering keeps the default of an input that has a value when that default fails to render, instead of failing the whole render. `bundle init` never uses that default, so it already worked there. Adds `setup_custom_host` to `acceptance/script.prepare` for tests that reach the test server as a host shared by several workspaces. ## Why Review comments on databricks#7350, which builds on this, and a follow-up review of databricks#7349. ## Tests The `workspace_variable` runtime test prints `URLID` for each kind of profile, and covers a failing default of an input with a value, every rejected workspace selector, and a protocol-relative path. This pull request and its description were written by Isaac. Co-authored-by: Isaac <no-reply@databricks.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Bundle templates can read the workspace of the selected profile as
.workspace, in template files and in the schema (defaults, descriptions, messages). It hasHostname,IDandURL.URL "/jobs"returns a workspace URL and adds?w=<id>when the profile, an environment variable, or a bundle in the working directory sets the workspace ID.IDfails when the ID is unknown and doesn't make a request to find it. A schema input namedworkspacetakes precedence.Schema rendering now renders the default of a property that already has an input value, instead of returning template text. The input value is kept.
Why
When several workspaces share one host,
workspace_hostcan't select the workspace. An ID that the SDK resolved from host metadata is not added to URLs, because a profile withoutworkspace_idwould then not match the host under strict profile matching.Tests
Acceptance tests cover URLs and IDs for each kind of profile, env vars, a bundle in the working directory, invalid paths, the
workspaceinput rules, and a schema rerender with edited inputs. Unit tests cover prompts andadb-<id>hosts.This pull request and its description were written by Isaac.