Repository navigation
air: Point to the databricks-ai-runtime skill in air run --help - #7628
anshul0713 wants to merge 3 commits into
Conversation
`databricks air run --help` now ends its description with the command that installs the databricks-ai-runtime agent skill. The install command is a shared constant, also used by the `-h config` skill note. Co-authored-by: Isaac <no-reply@databricks.com>
Co-authored-by: Isaac <no-reply@databricks.com>
|
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. |
Co-authored-by: Isaac <no-reply@databricks.com>
|
@anton-107 this PR is from a fork, so every |
|
An authorized user can trigger integration tests manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
|
Superseded by #7652, the same change opened from a branch in this repo so CI can run. |
…bricks#7652) Replaces databricks#7628, which was opened from a fork and couldn't run CI. Same change, rebased on `main`. ## Changes `databricks air run --help` now names the databricks-ai-runtime agent skill and gives the install command, below the `-h config` lookup lines: ``` databricks air run -h config.compute.accelerator_type one field To have a coding agent write the YAML and follow the run, install the databricks-ai-runtime skill: databricks aitools install --skills-only --skills databricks-ai-runtime ``` - The install command is now a constant, `skillInstallCommand`, in `cmd/air/runconfig.go`. The `-h config` skill note uses it as well. - The `air -h` footer in `cmd/air/air.go` still has its own copy of the command. I left that file alone because databricks#7622 edits the same footer. It can move to the constant after that PR lands. ## Why Coding agents read `air run --help` right before they write a workload YAML, so this page should point to the skill. - On v1.26.0 the skill appears only in `air run -h config`. - On `main`, databricks#7512 added it to the `air -h` footer too. `air run --help` still doesn't mention it. - databricks#7622 makes the install hint name this skill on air subcommands. That hint runs from `PersistentPreRunE`, and cobra doesn't run that for `--help`. Help text is the only way to show the skill on help pages. ## Tests - New unit test `TestRunHelpPointsToAgentSkill` in `cmd/air/air_test.go`. - Regenerated `acceptance/air/config-help/output.txt` with `-update`. The only diff is the 5 new lines in `air run --help`. - Passing: `go test ./acceptance -run 'TestAccept/air/'`, `go vet ./cmd/air/`, `./task lint-q` and `./task ws`. - `go test ./cmd/air/` passes except `TestLogsCommandRepeatsRunLinkAfterStreaming`. That test fails the same way on an unmodified `origin/main` checkout (bdb37ab) in this environment. This pull request and its description were written by Isaac. --------- Co-authored-by: Isaac <no-reply@databricks.com>
Changes
databricks air run --helpnow names the databricks-ai-runtime agent skill and gives the install command, below the-h configlookup lines:skillInstallCommand, incmd/air/runconfig.go. The-h configskill note uses it as well.air -hfooter incmd/air/air.gostill has its own copy of the command. I left that file alone because aitools: Hint the AI Runtime skill on air subcommands #7622 edits the same footer. It can move to the constant after that PR lands.Why
Coding agents read
air run --helpright before they write a workload YAML, so this page should point to the skill.air run -h config.main, [air] Reorganizedatabricks airhelp around the run lifecycle #7512 added it to theair -hfooter too.air run --helpstill doesn't mention it.PersistentPreRunE, and cobra doesn't run that for--help. Help text is the only way to show the skill on help pages.Tests
TestRunHelpPointsToAgentSkillincmd/air/air_test.go.acceptance/air/config-help/output.txtwith-update. The only diff is the 5 new lines inair run --help.go test ./acceptance -run 'TestAccept/air/',go vet ./cmd/air/,./task lint-qand./task ws.go test ./cmd/air/passes exceptTestLogsCommandRepeatsRunLinkAfterStreaming. That test fails the same way on an unmodifiedorigin/maincheckout (bdb37ab) in this environment.This pull request and its description were written by Isaac.