Document + modifier syntax in bundle run --only help#5760
Conversation
4b5431e to
e34491a
Compare
Approval status: pending
|
e34491a to
6ba3ad7
Compare
--only flag to jobs run-now+ modifier syntax in bundle run --only help
`bundle run --only` accepts task keys to run a subset of a job's tasks. A task key may be prefixed with `+` (also run upstream tasks) or suffixed with `+` (also run downstream tasks); document that in the flag's help text. Co-authored-by: Isaac
Add a partial_run case asserting `--only +task_1,task_2+` forwards unchanged to the run-now `only` field, proving the CLI does not mangle or reject the upstream/downstream modifier syntax documented on the flag. Co-authored-by: Isaac
3c8922a to
71d5c4b
Compare
|
An authorized user can trigger integration tests manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
## Changes The `bundle run --only` command takes a comma-separated list of task keys to run a subset of a job's tasks. Its help text did not mention that a task key can be prefixed or suffixed with `+` to also pull in upstream/downstream tasks (the value is forwarded to the run-now only API field, which interprets the modifiers). This documents that syntax in the flag's help: * `+my_task`: run `my_task` and everything upstream of it * `my_task+`: run `my_task` and everything downstream of it * `+my_task+`: both Supercedes databricks#5760, addresses databricks#4244 ## Why Documentation was out of date so agents & users were not able to use the new functionality ## Tests Yes, new tests assert that the data is passed through unchanged
## Release v1.7.0 ### CLI * An explicitly selected profile (`--profile` or a bundle's `workspace.profile`) now takes precedence over auth environment variables (`DATABRICKS_HOST`, `DATABRICKS_TOKEN`, etc.) instead of being silently shadowed by them; env vars still fill auth fields the profile leaves empty ([#5096](#5096)). * Fix intermittent crashes when processing pages from API calls ([#5815](#5815)). ### Bundles * direct: add basic version of job_runs resource (experimental) ([#5603](#5603)). * Fix permissions added to a job or pipeline by a Python (PyDABs) mutator failing to deploy with "must have exactly one owner"; the deploying identity is now set as owner, matching resources whose permissions are declared in YAML ([#5821](#5821)). * Remove duplicate enum values for jsonschema.json ([#5839](#5839)). * direct: volumes: support `volume_path` property ([#5550](#5550)). * direct: Fix deploy bug when a `postgres_projects`, `postgres_branches`, or `postgres_endpoints` field is set to its zero value (e.g. `enable_pg_native_login: false`, `replace_existing: false`) ([#5782](#5782)). * `bundle run --only` help now documents the `+` modifier syntax: prefix a task key with `+` to also run its upstream tasks, or suffix it with `+` for downstream tasks ([#5760](#5760)). * direct: Recognize UC-managed catalog and schema property defaults to avoid unnecessary drift ([#5865](#5865) & [#5870](#5870)). * Fix `bundle deploy --select <resource>` skipping the resource's grants and permissions; they are now applied as part of the selected resource ([#5852](#5852)). * Support `purge_on_delete: true` on `postgres_branches` so bundles can hard-delete a Lakebase branch on destroy (skipping the soft-delete retention window) ([#5801](#5801)). * Support `replace_existing: true` on `postgres_databases` and `postgres_roles` so bundles can take over a database or role that already exists on a Lakebase branch instead of failing with `ALREADY_EXISTS` ([#5803](#5803)). ### Dependency updates * Bump databricks-sdk-go to v0.154.0 ([#5855](#5855)). * Bump terraform-provider to 1.121.0 ([#5857](#5857)). * Bump OpenTelemetry dependencies to v1.44.0 to address [CVE-2026-41178](GHSA-5wrp-cwcj-q835) ([#5873](#5873)).
Changes
bundle run --onlytakes a comma-separated list of task keys to run a subset of a job's tasks. Its help text did not mention that a task key can be prefixed or suffixed with+to also pull in upstream/downstream tasks (the value is forwarded to therun-nowonlyAPI field, which interprets the modifiers). This documents that syntax in the flag's help:+my_task: runmy_taskand everything upstream of itmy_task+: runmy_taskand everything downstream of it+my_task+: bothAdresses #4244
Tests
acceptance/bundle/run/jobs/partial_runcase asserts--only +task_1,task_2+is forwarded unchanged to the run-now request body ("only": ["+task_1", "task_2+"]), proving the documented+syntax is not mangled or rejected client-side.bundle run --helpgolden for the updated--onlydescription.This pull request and its description were written by Isaac.