Repository navigation
Conversation
…ide the bundle When code_source.root_path resolved outside the bundle directory, for example the getting-started Ray recipes that snapshot their parent directory with root_path: .., convert-to-dabs suggested setting sync.paths in a databricks.yml that it had not written. The error now names the resolved code directory and, for working-tree snapshots, the --output-dir value that converts the workload. Co-authored-by: Isaac <no-reply@databricks.com>
Co-authored-by: Isaac <no-reply@databricks.com>
Contributor
|
Thanks for the contribution! This pull request was opened from a fork. If you're a member of the Databricks organization, please request access to the If you're an external contributor, no action is needed; a maintainer will review your pull request. |
Contributor
|
An authorized user can trigger integration tests manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
Member
Author
|
Superseded by #7644, which uses a branch in this repository so CI can run. |
idelafuente-oc
pushed a commit
to idelafuente-oc/cli
that referenced
this pull request
Nov 20, 2026
…ide the bundle (databricks#7644) ## Changes - `air convert-to-dabs`: when `code_source.root_path` resolves outside the bundle directory, the error names the resolved code directory and, for working-tree snapshots, the `--output-dir` that converts the workload: the code directory's parent, quoted for the user's shell (cmd.exe or PowerShell on Windows, a POSIX shell elsewhere). It no longer suggests setting `sync.paths` in a `databricks.yml` it has not written. - When that parent already holds a bundle file (`databricks.yml`, `databricks.yaml`, `bundle.yml` or `bundle.yaml`), the error says so instead of suggesting it. Sibling workloads that share a code directory would otherwise each be sent there and replace one another's bundle. - A parent path that no quoting keeps literal, such as one with a control character, gets generic wording instead of a printed path. - `quoteArg` moves from `cmd/aitools` to `libs/shellquote` as `Arg`, unchanged apart from the name, so both commands quote printed paths the same way. - Git-pinned snapshots still get only "move the code inside the bundle directory", matching the rule for the bundle-root case in databricks#7579. ## Why The getting-started Ray recipes in the AI Runtime cookbook snapshot their parent directory (`root_path: ..`) to include a shared bootstrap. Running `convert-to-dabs workload.yaml` from a recipe directory failed with advice to set `sync.paths` in a `databricks.yml` the command had not written; the conversion works with `--output-dir ../..`, which no message mentioned. Four recipes share that parent, so the hint must not steer a second conversion into the first one's bundle. Replaces databricks#7640, opened from a fork where CI could not get its OIDC token. ## Tests - `TestConvertToDabsCodeOutsideBundleSuggestsOutputDir`: the error names the resolved code directory, `--output-dir <parent>` and the fallback, not `sync.paths`; converting with that directory succeeds with the expected artifact `path` and `include`. - `TestConvertToDabsCodeOutsideBundleSkipsParentWithBundle`: for each bundle file name, the error says the parent holds a bundle and does not suggest it. - `TestConvertToDabsCodeOutsideBundleQuotesOutputDir`: a parent path with a space is quoted for the platform's shell. - `TestConvertToDabsGitPinOutsideBundleDoesNotSuggestOutputDir`: git-pinned snapshots get only the move-the-code remedy. `TestArg` covers the moved helper. - Removing the bundle-file check or the quoting makes the corresponding test fail. - Ran the built CLI on a copy of the cookbook's Ray recipes: Ray Core suggests the parent and converts there, and Ray Data then reports the existing bundle. - `acceptance/air/convert-to-dabs` adds a workload whose `root_path` is outside its directory. Converted before the in-place bundle exists, the error suggests `--output-dir` with the code directory's parent; converted after it, the error reports the parent's `databricks.yml`. Both cases fail against `main`'s `convert_to_dabs.go`, which prints the old `sync.paths` advice. - `go test ./cmd/air/... ./libs/shellquote/...`, `go test ./acceptance -run TestAccept/air`, and `./task test-exp-aitools` pass, and `golangci-lint run` reports no issues on the changed packages. - Not covered here: re-running a workload whose own bundle is in the parent is told to use another directory instead of `--force`, and `--force` still replaces a bundle with a different `bundle.name`. Both belong to a follow-up that compares bundle names. Git-pinned snapshots also still get only the move-the-code remedy, although `--output-dir` with the parent works for them unless the code directory is the repository's top level. 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
air convert-to-dabs: whencode_source.root_pathresolves outside the bundle directory, the error names the resolved code directory and, for working-tree snapshots, the--output-dirthat converts the workload (the code directory's parent). It no longer suggests settingsync.pathsindatabricks.yml.Why
The getting-started Ray recipes in the AI Runtime cookbook snapshot their parent directory (
root_path: ..) to include a shared bootstrap. Runningconvert-to-dabs workload.yamlfrom the recipe directory failed with advice to setsync.pathsin adatabricks.ymlthat the command had not written, and the generated bundle only syncsgenerated_artifactswhile thetgzartifact packages code inside the bundle anyway. The conversion works with--output-dir ../.., which no message mentioned.Tests
TestConvertToDabsCodeOutsideBundleSuggestsOutputDirreproduces the Ray layout: the error names--output-dir <parent>and notsync.paths, and converting with that directory succeeds with the expected artifactinclude.TestConvertToDabsGitPinOutsideBundleDoesNotSuggestOutputDirchecks git-pinned snapshots get no--output-dirhint.TestConvertToDabsRejectsCodeOutsideBundlepasses unchanged.go test ./cmd/air/...andgo test ./acceptance -run TestAccept/airpass;golangci-lint run ./cmd/air/...reports no issues.This pull request and its description were written by Isaac.