Skip to content

Add pipelines describe command (hidden) - #6581

Open
chenyuem-db wants to merge 1 commit into
databricks:mainfrom
chenyuem-db:pipelines-describe
Open

Add pipelines describe command (hidden)#6581
chenyuem-db wants to merge 1 commit into
databricks:mainfrom
chenyuem-db:pipelines-describe

Conversation

@chenyuem-db

@chenyuem-db chenyuem-db commented Sep 9, 2026

Copy link
Copy Markdown

What

Adds a databricks pipelines describe command that summarizes a pipeline — its configuration, current state, and the result of its most recent update. The pipeline can be addressed by bundle KEY, or by PIPELINE_ID (a UUID, which needs no bundle).

Output defaults to a readable text summary (like run / show / history); --output json is available for scripting.

Also exports LooksLikeUUID from cmd/pipelines and reuses it in the stop override, removing a duplicate copy.

Why it's hidden

The command is marked Hidden: true because part of its intended output is still WIP: richer sections (datasets, lineage) depend on pipeline-entity APIs that aren't public yet. Landing the basics now, hidden, lets the command be iterated on without advertising an incomplete surface. It will be unhidden once the fuller output is in.

Tests

  • Unit: TestLooksLikeUUID, TestPipelineDescribeTemplateNoRuns.
  • Acceptance: acceptance/pipelines/describe/basic (describe by PIPELINE_ID, text + JSON).
  • go test ./cmd/pipelines/ ./cmd/workspace/pipelines/, gofmt, and go vet pass.

This pull request and its description were written by Isaac.

Show a pipeline's configuration and current state, plus the result of its
most recent update. The pipeline can be addressed by bundle KEY (resolved
via the bundle) or by PIPELINE_ID (a UUID), which is resolved directly and
needs no bundle.

Backed by the public Get and GetUpdate APIs, called in the same request-
struct style as `pipelines run`. Hidden for now because output is limited
to basic info; unhide once richer output (datasets, DAG, lineage) lands.

Exports LooksLikeUUID from cmd/pipelines and reuses it in the workspace
`stop` override instead of a second copy. Adds a describe-by-id acceptance
test.

Co-authored-by: Isaac <no-reply@databricks.com>
@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

An authorized user can trigger integration tests manually by following the instructions below:

Trigger:
go/deco-tests-run/cli

Inputs:

  • PR number: 6581
  • Commit SHA: cbb90b6aed23033f487b27783c40b90b0cc8c7f7

Checks will be approved automatically on success.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Approval status: pending

/acceptance/pipelines/ - needs approval

4 files changed
Suggested: @kanterov
Also eligible: @jefferycheng1, @lennartkats-db

/cmd/pipelines/ - needs approval

4 files changed
Suggested: @kanterov
Also eligible: @jefferycheng1, @lennartkats-db

General files (require maintainer)

Files: cmd/workspace/pipelines/overrides.go, cmd/workspace/pipelines/overrides_test.go
Based on git history:

  • @pietern -- recent work in cmd/pipelines/

Any maintainer (@andrewnester, @anton-107, @denik, @pietern, @shreyas-goenka, @simonfaltum, @renaudhartert-db, @janniklasrose, @lennartkats-db, @rugpanov, @rclarey) can approve all areas.
See OWNERS for ownership rules.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant