Skip to content

experimental/ssh: replace verbose disclaimer with lightweight [EXPERIMENTAL] tag#5326

Open
TanishqDatabricks wants to merge 9 commits into
databricks:mainfrom
TanishqDatabricks:ssh-experimental-tag
Open

experimental/ssh: replace verbose disclaimer with lightweight [EXPERIMENTAL] tag#5326
TanishqDatabricks wants to merge 9 commits into
databricks:mainfrom
TanishqDatabricks:ssh-experimental-tag

Conversation

@TanishqDatabricks
Copy link
Copy Markdown
Collaborator

Summary

  • Removes the verbose legal-style disclaimer constant (preview status, billing, SLA language)
  • Adds [EXPERIMENTAL] prefix to Short and Long descriptions for all ssh commands (ssh, connect, setup, server)
  • Adds a single-line note: "This is an experimental feature and is subject to change."
  • Follows the same pattern used by bundle config-remote-sync

Stacked on #5325 — merge that first.

Test plan

  • databricks ssh --help, databricks ssh connect --help, databricks ssh setup --help, databricks ssh server --help show [EXPERIMENTAL] tag instead of disclaimer

This pull request and its description were written by Isaac.

Updates the help text for `databricks ssh`, `databricks ssh connect`, and
`databricks ssh setup` based on the May 1 2026 Remote Development CUJ.

- `databricks ssh`: common-workflows examples now lead with serverless
  (no flags), with the dedicated-cluster path as a follow-up.
- `databricks ssh connect`: Long description groups example invocations
  by serverless vs dedicated. Unhides --name, --accelerator, --ide,
  --environment-version so users can discover them via --help.
- `databricks ssh setup`: tightened Short/Long to clarify it's for
  dedicated clusters; users on serverless should just use connect.

Co-authored-by: Isaac
@github-actions
Copy link
Copy Markdown
Contributor

Waiting for approval

Based on git history, these people are best suited to review:

  • @ilia-db -- recent work in experimental/ssh/cmd/

Eligible reviewers: @andrewnester, @anton-107, @denik, @pietern, @renaudhartert-db, @shreyas-goenka, @simonfaltum

Suggestions based on git history. See OWNERS for ownership rules.

@anton-107 anton-107 self-requested a review May 26, 2026 07:20
Copy link
Copy Markdown
Contributor

@anton-107 anton-107 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove the word "experimental" from all help notes.

That means:

  • Drop the [EXPERIMENTAL] prefix from every Short and Long in ssh.go, connect.go, setup.go, and server.go.
  • Drop the "This is an experimental feature and is subject to change." line from each Long.

If we want to signal preview status to users, let's discuss what wording to use instead — but as it stands, "experimental" should not appear in any of the help text.

…nt, drop [EXPERIMENTAL]

- Hide --environment-version flag (not ready for users)
- Replace tabs with spaces so # comments align consistently
- Use <name> instead of <connection> to match the --name flag
- Remove [EXPERIMENTAL] tag and disclaimer from all three commands

Co-authored-by: Isaac
@github-actions
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: 5326
  • Commit SHA: d897358bc4f113a58af644287e3c481078e8f7c3

Checks will be approved automatically on success.

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.

2 participants