Skip to content

Update error messages to suggest 'databricks auth login' - #4587

Merged
simonfaltum merged 1 commit into
mainfrom
simonfaltum/update-configure-to-auth-login
Feb 24, 2026
Merged

Update error messages to suggest 'databricks auth login'#4587
simonfaltum merged 1 commit into
mainfrom
simonfaltum/update-configure-to-auth-login

Conversation

@simonfaltum

@simonfaltumsimonfaltum commented Feb 24, 2026

Copy link
Copy Markdown
Member

Why

Several error messages in the CLI suggest running databricks configure to create profiles. This is outdated — the golden path is databricks auth login (OAuth-based). Telling users to run databricks configure leads them into a PAT-based manual config flow instead of the preferred OAuth flow.

Changes

Update all error messages that suggest databricks configure to suggest databricks auth login instead. No functional changes — only user-facing strings.

  • libs/auth/error.go — PAT, basic auth, and env-var auth remediation suggestions
  • cmd/root/auth.go — "no workspace profiles" error
  • libs/databrickscfg/profile/file.go — "no configuration file" error
  • libs/template/helpers.gosmallest_node_type and workspace_host template helpers
  • acceptance/workspace/jobs/create-error/output.txt — acceptance test golden file

Template README files (libs/template/templates/) also reference databricks configure but those are onboarding instructions, not error messages, and are out of scope for this change.

Test

Tested manually to verify the new error messages

  1. Missing config file: ...please create one by running 'databricks auth login'
  2. 401 with env-var PAT: Consider setting up a profile: databricks auth login --profile
  • go test ./libs/auth/ ./cmd/root/ ./libs/databrickscfg/profile/ ./libs/template/ — all pass
  • go build ./... — compiles cleanly
  • make checks — passes
  • rg "databricks configure" --glob "*.go" — zero matches in Go source
  • rg "databricks configure" --glob "**/output.txt" — zero matches in acceptance golden files

…databricks configure'
The golden path for authentication is OAuth-based 'databricks auth login',
not the PAT-based 'databricks configure'. Update all user-facing error
messages to point users to the correct command.
@eng-dev-ecosystem-bot

eng-dev-ecosystem-bot commented Feb 24, 2026

Copy link
Copy Markdown
Collaborator

Commit: f1cc4a0

Run: 22353055190

Env🟨​KNOWN💚​RECOVERED🙈​SKIP✅​pass🙈​skipTime
🟨​aws linux7172687636:11
🟨​aws windows7172707615:57
💚​aws-ucws linux873646796:17
💚​aws-ucws windows873666775:02
💚​azure linux292717615:52
💚​azure windows292737593:51
💚​azure-ucws linux293696756:10
💚​azure-ucws windows293716735:48
💚​gcp linux292677645:22
💚​gcp windows292697625:54
15 interesting tests: 7 KNOWN, 7 SKIP, 1 RECOVERED
Test Nameaws linuxaws windowsaws-ucws linuxaws-ucws windowsazure linuxazure windowsazure-ucws linuxazure-ucws windowsgcp linuxgcp windows
🟨​TestAccept🟨​K🟨​K💚​R💚​R💚​R💚​R💚​R💚​R💚​R💚​R
🙈​TestAccept/bundle/resources/permissions🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S
🟨​TestAccept/bundle/resources/permissions/jobs/destroy_without_mgmtperms/with_permissions🟨​K🟨​K💚​R💚​R🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S
🟨​TestAccept/bundle/resources/permissions/jobs/destroy_without_mgmtperms/with_permissions/DATABRICKS_BUNDLE_ENGINE=direct🟨​K🟨​K💚​R💚​R
🟨​TestAccept/bundle/resources/permissions/jobs/destroy_without_mgmtperms/with_permissions/DATABRICKS_BUNDLE_ENGINE=terraform🟨​K🟨​K💚​R💚​R
🟨​TestAccept/bundle/resources/permissions/jobs/destroy_without_mgmtperms/without_permissions🟨​K🟨​K💚​R💚​R🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S
🟨​TestAccept/bundle/resources/permissions/jobs/destroy_without_mgmtperms/without_permissions/DATABRICKS_BUNDLE_ENGINE=direct🟨​K🟨​K💚​R💚​R
🟨​TestAccept/bundle/resources/permissions/jobs/destroy_without_mgmtperms/without_permissions/DATABRICKS_BUNDLE_ENGINE=terraform🟨​K🟨​K💚​R💚​R
🙈​TestAccept/bundle/resources/postgres_branches/basic🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S
🙈​TestAccept/bundle/resources/postgres_branches/recreate🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S
🙈​TestAccept/bundle/resources/postgres_branches/update_protected🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S
🙈​TestAccept/bundle/resources/postgres_branches/without_branch_id🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S
🙈​TestAccept/bundle/resources/postgres_endpoints/recreate🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S
🙈​TestAccept/bundle/resources/synced_database_tables/basic🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S🙈​S
💚​TestAccept/ssh/connection💚​R💚​R💚​R💚​R💚​R💚​R💚​R💚​R💚​R💚​R
Top 20 slowest tests (at least 2 minutes):
durationenvtestname
4:15gcp windowsTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
3:49gcp linuxTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
3:20aws-ucws windowsTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
3:19azure-ucws windowsTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
3:17azure linuxTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
3:14azure-ucws windowsTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
3:06gcp linuxTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
3:06gcp windowsTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
2:53aws windowsTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
2:52aws linuxTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
2:51aws windowsTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
2:51aws-ucws windowsTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
2:47aws-ucws linuxTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
2:45aws-ucws linuxTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
2:45aws linuxTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
2:16azure linuxTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
2:16azure-ucws linuxTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
2:10azure windowsTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=terraform
2:06azure windowsTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct
2:03azure-ucws linuxTestAccept/bundle/resources/apps/inline_config/DATABRICKS_BUNDLE_ENGINE=direct

@simonfaltum
simonfaltum added this pull request to the merge queueFeb 24, 2026
Merged via the queue into main with commit 8d7324dFeb 24, 2026
18 checks passed
@simonfaltum
simonfaltum deleted the simonfaltum/update-configure-to-auth-login branch February 24, 2026 14:04
deco-sdk-taggingBot added a commit that referenced this pull request Feb 26, 2026
## Release v0.290.0
### CLI
* Add `completion install`, `uninstall`, and `status` subcommands ([#4581](#4581))
* Wire profile name through CLI ToOAuthArgument for profile-based cache keys ([#4562](#4562))
* Add host disambiguation and positional profile support to auth token ([#4574](#4574))
* Update error messages to suggest 'databricks auth login' ([#4587](#4587))
* Resolve --host to matching profile for token cache lookup ([#4591](#4591))
* Improve auth token UX: profile selection and better empty-state handling ([#4584(#4584)
### Bundles
* Added support for git_source and git_repository for Apps ([#4538](#4538))
### Dependency updates
* Upgrade TF provider to 1.109.0 ([#4561](#4561))
* Upgrade Go SDK to v0.110.0 ([#4552](#4552))
### API Changes
* Bump databricks-sdk-go from v0.111.0 to v0.112.0.
denik pushed a commit that referenced this pull request May 20, 2026
## Why
Several error messages in the CLI suggest running `databricks configure`
to create profiles. This is outdated — the golden path is `databricks
auth login` (OAuth-based). Telling users to run `databricks configure`
leads them into a PAT-based manual config flow instead of the preferred
OAuth flow.
## Changes
Update all error messages that suggest `databricks configure` to suggest
`databricks auth login` instead. No functional changes — only
user-facing strings.
- `libs/auth/error.go` — PAT, basic auth, and env-var auth remediation
suggestions
- `cmd/root/auth.go` — "no workspace profiles" error
- `libs/databrickscfg/profile/file.go` — "no configuration file" error
- `libs/template/helpers.go` — `smallest_node_type` and `workspace_host`
template helpers
- `acceptance/workspace/jobs/create-error/output.txt` — acceptance test
golden file
Template README files (`libs/template/templates/`) also reference
`databricks configure` but those are onboarding instructions, not error
messages, and are out of scope for this change.
## Test
Tested manually to verify the new error messages
1. Missing config file: ...please create one by running 'databricks auth
login'
2. 401 with env-var PAT: Consider setting up a profile: databricks auth
login --profile <name>
- `go test ./libs/auth/ ./cmd/root/ ./libs/databrickscfg/profile/
./libs/template/` — all pass
- `go build ./...` — compiles cleanly
- `make checks` — passes
- `rg "databricks configure" --glob "*.go"` — zero matches in Go source
- `rg "databricks configure" --glob "**/output.txt"` — zero matches in
acceptance golden files
denik pushed a commit that referenced this pull request May 20, 2026
## Release v0.290.0
### CLI
* Add `completion install`, `uninstall`, and `status` subcommands ([#4581](#4581))
* Wire profile name through CLI ToOAuthArgument for profile-based cache keys ([#4562](#4562))
* Add host disambiguation and positional profile support to auth token ([#4574](#4574))
* Update error messages to suggest 'databricks auth login' ([#4587](#4587))
* Resolve --host to matching profile for token cache lookup ([#4591](#4591))
* Improve auth token UX: profile selection and better empty-state handling ([#4584(#4584)
### Bundles
* Added support for git_source and git_repository for Apps ([#4538](#4538))
### Dependency updates
* Upgrade TF provider to 1.109.0 ([#4561](#4561))
* Upgrade Go SDK to v0.110.0 ([#4552](#4552))
### API Changes
* Bump databricks-sdk-go from v0.111.0 to v0.112.0.
Sign up for freeto 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.

3 participants

@simonfaltum@eng-dev-ecosystem-bot@andrewnester