From 4a6f87c9154c7e67eff0f32f24b77a6d96808473 Mon Sep 17 00:00:00 2001 From: Andrew Nester Date: Mon, 16 Sep 2024 16:40:11 +0200 Subject: [PATCH] change link to docs page --- .../config/mutator/rewrite_workspace_prefix.go | 2 +- .../mutator/rewrite_workspace_prefix_test.go | 6 +++--- docs/release_notes/workspace_prefix.md | 17 ----------------- 3 files changed, 4 insertions(+), 21 deletions(-) delete mode 100644 docs/release_notes/workspace_prefix.md diff --git a/bundle/config/mutator/rewrite_workspace_prefix.go b/bundle/config/mutator/rewrite_workspace_prefix.go index 86487a17ec..9d69b11a19 100644 --- a/bundle/config/mutator/rewrite_workspace_prefix.go +++ b/bundle/config/mutator/rewrite_workspace_prefix.go @@ -44,7 +44,7 @@ func (m *rewriteWorkspacePrefix) Apply(ctx context.Context, b *bundle.Bundle) di if strings.Contains(vv, path) { diags = append(diags, diag.Diagnostic{ Severity: diag.Warning, - Summary: fmt.Sprintf("substring %q found in %q. Please update this to %q. For more information, please refer to: https://github.com/databricks/cli/blob/main/docs/release_notes/workspace_prefix.md", path, vv, strings.Replace(vv, "/Workspace/", "", 1)), + Summary: fmt.Sprintf("substring %q found in %q. Please update this to %q. For more information, please refer to: https://docs.databricks.com/en/release-notes/bundles.html#workspace-paths-will-be-automatically-prefixed", path, vv, strings.Replace(vv, "/Workspace/", "", 1)), Locations: v.Locations(), Paths: []dyn.Path{p}, }) diff --git a/bundle/config/mutator/rewrite_workspace_prefix_test.go b/bundle/config/mutator/rewrite_workspace_prefix_test.go index 2cea75aab4..73c6d0e9b7 100644 --- a/bundle/config/mutator/rewrite_workspace_prefix_test.go +++ b/bundle/config/mutator/rewrite_workspace_prefix_test.go @@ -65,9 +65,9 @@ func TestNoWorkspacePrefixUsed(t *testing.T) { require.Len(t, diags, 3) expectedErrors := map[string]bool{ - `substring "/Workspace/${workspace.root_path}" found in "/Workspace/${workspace.root_path}/file1.py". Please update this to "${workspace.root_path}/file1.py". For more information, please refer to: https://github.com/databricks/cli/blob/main/docs/release_notes/workspace_prefix.md`: true, - `substring "/Workspace/${workspace.file_path}" found in "/Workspace/${workspace.file_path}/notebook1". Please update this to "${workspace.file_path}/notebook1". For more information, please refer to: https://github.com/databricks/cli/blob/main/docs/release_notes/workspace_prefix.md`: true, - `substring "/Workspace/${workspace.artifact_path}" found in "/Workspace/${workspace.artifact_path}/jar1.jar". Please update this to "${workspace.artifact_path}/jar1.jar". For more information, please refer to: https://github.com/databricks/cli/blob/main/docs/release_notes/workspace_prefix.md`: true, + `substring "/Workspace/${workspace.root_path}" found in "/Workspace/${workspace.root_path}/file1.py". Please update this to "${workspace.root_path}/file1.py". For more information, please refer to: https://docs.databricks.com/en/release-notes/bundles.html#workspace-paths-will-be-automatically-prefixed`: true, + `substring "/Workspace/${workspace.file_path}" found in "/Workspace/${workspace.file_path}/notebook1". Please update this to "${workspace.file_path}/notebook1". For more information, please refer to: https://docs.databricks.com/en/release-notes/bundles.html#workspace-paths-will-be-automatically-prefixed`: true, + `substring "/Workspace/${workspace.artifact_path}" found in "/Workspace/${workspace.artifact_path}/jar1.jar". Please update this to "${workspace.artifact_path}/jar1.jar". For more information, please refer to: https://docs.databricks.com/en/release-notes/bundles.html#workspace-paths-will-be-automatically-prefixed`: true, } for _, d := range diags { diff --git a/docs/release_notes/workspace_prefix.md b/docs/release_notes/workspace_prefix.md deleted file mode 100644 index a1f53a0b67..0000000000 --- a/docs/release_notes/workspace_prefix.md +++ /dev/null @@ -1,17 +0,0 @@ -## /Workspace prefix - -This PR (https://github.com/databricks/cli/pull/1724) introduced the following changes: - -1. Default remote bundle paths became automatically prefixed with /Workspace prefix -2. All usage of path strings like `/Workspace/${workspace.root_path}/...` and etc. in bundle configuration now automatically replaced with `${workspace.root_path}/...` and generates a warning as part of `bundle validate` - -If users have specified a custom `workspace.{root,artifact,file,state}_path`, then DABs will automatically ensure it is prefixed with /Workspace. - -This also means that if they use any of these as variables (for example, `my_config_path: /Workspace/${workspace.file_path}/config`), then they’ll need to update those entries to remove the `/Workspace` prefix to avoid the warning. - -If they pass along one of these as variables and prefix them in their code, they’ll need to update their code to no longer do this. - -The reason for this is the following: - -Historically, the workspace file system was rooted at `/`, with home directories under `/Users`, for example. -To access workspace paths through the API you would use these paths directly. To access workspace paths from your code, you could use the `/Workspace` file path that mounts the workspace file system on Databricks clusters. Home directories were available under `/Workspace/Users`. This duality proved inconvenient, and with the introduction of UC volumes it even became ambiguous (UC volumes are accessible under `/Volumes` ). To avoid both the duality of workspace paths and as well as ambiguity between workspace paths and UC volume paths, we’re now prefixing all workspace paths with `/Workspace`. This means they no longer need to be manually prefixed to be used as a POSIX path (e.g. to open a file from Python), nor is there ambiguity between workspace paths and UC volume paths.