Skip to content

Simplify auth login help text, document query parameter support#4906

Merged
simonfaltum merged 1 commit intomainfrom
simonfaltum/auth-login-help
Apr 7, 2026
Merged

Simplify auth login help text, document query parameter support#4906
simonfaltum merged 1 commit intomainfrom
simonfaltum/auth-login-help

Conversation

@simonfaltum
Copy link
Copy Markdown
Member

@simonfaltum simonfaltum commented Apr 7, 2026

Why

The auth login help text was verbose and redundant. Four numbered scenarios all described the same core behavior (profile is created or updated) with minor variations, and each repeated the "databricks-cli" auth type implementation detail. The help text also didn't mention URL query parameter support (?o=, ?account_id=).

Changes

Before: ~40 lines of help text with four near-identical scenarios explaining profile update behavior, specific SDK names that will go stale, and no mention of query parameter support.

Now: ~20 lines. Drops the redundant scenarios in favor of one sentence ("If a profile with the given name already exists, it is updated. Otherwise a new profile is created."). Adds documentation for URL query parameters (?o=<workspace_id>&account_id=<id>) with a shell quoting note. Replaces specific SDK list with generic "SDKs".

Test plan

  • make checks passes
  • databricks auth login --help shows updated text
  • No functional changes, help text only

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 7, 2026

Suggested reviewers

Based on git history of the changed files, these people are best suited to review:

Confidence: low

Eligible reviewers

Based on CODEOWNERS, these people or teams could also review:

@andrewnester, @anton-107, @denik, @shreyas-goenka

Suggestions based on git history of 1 changed files (1 scored). See CODEOWNERS for path-specific ownership rules.

@simonfaltum simonfaltum requested review from mihaimitrea-db and removed request for andrewnester, anton-107, denik, pietern and shreyas-goenka April 7, 2026 12:57
@simonfaltum simonfaltum enabled auto-merge April 7, 2026 13:03
@simonfaltum simonfaltum added this pull request to the merge queue Apr 7, 2026
Merged via the queue into main with commit 476af5d Apr 7, 2026
18 checks passed
@simonfaltum simonfaltum deleted the simonfaltum/auth-login-help branch April 7, 2026 13:22
simonfaltum added a commit that referenced this pull request Apr 8, 2026
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