Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add better documentation for the auth login command #1366

Merged
merged 13 commits into from Apr 18, 2024
Merged

Add better documentation for the auth login command #1366

merged 13 commits into from Apr 18, 2024
+49 −4

Conversation

shreyas-goenka
Copy link
Contributor

@shreyas-goenka shreyas-goenka commented Apr 15, 2024 •
edited

This PR improves the documentation for the auth login command, accounting for the various ways this command can be used in.

@shreyas-goenka shreyas-goenka requested review from mgyucht, pietern and andrewnester and removed request for mgyucht and pietern April 15, 2024 17:24
@PaulCornellDB
Copy link
Contributor

  • Is [HOST] is always required?
  • Can I just specify --profile or -p instead of [HOST]? If I can't but try to anyway, what happens?
  • What if I specify both [HOST] and --profile or -p?

@shreyas-goenka
Copy link
Contributor Author

Thanks for the feedback @PaulCornellDB. I have updated the documentation to hopefully answer your questions better.

Is [HOST] is always required?

No. The user is prompted if it's not specified.

Can I just specify --profile or -p instead of [HOST]? If I can't but try to anyway, what happens?

Yeah you can. In that case you are logged into the host specified by your profile.

What if I specify both [HOST] and --profile or -p?

You'll be logged into the host specified by [HOST]. Your profile will also be updated.

PaulCornellDB
PaulCornellDB reviewed Apr 16, 2024
View reviewed changes
cmd/auth/login.go Outdated Show resolved Hide resolved
PaulCornellDB
PaulCornellDB reviewed Apr 16, 2024
View reviewed changes
cmd/auth/login.go Outdated Show resolved Hide resolved
PaulCornellDB
PaulCornellDB reviewed Apr 16, 2024
View reviewed changes
cmd/auth/login.go Outdated Show resolved Hide resolved
PaulCornellDB
PaulCornellDB reviewed Apr 16, 2024
View reviewed changes
cmd/auth/login.go Outdated Show resolved Hide resolved
pietern
pietern approved these changes Apr 18, 2024
View reviewed changes
cmd/auth/login.go Outdated Show resolved Hide resolved
cmd/auth/login.go Outdated Show resolved Hide resolved
shreyas-goenka and others added 2 commits April 18, 2024 17:20
@shreyas-goenka @pietern
Update cmd/auth/login.go
bd323bb 
Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>
@shreyas-goenka @pietern
Update cmd/auth/login.go
7c16685 
Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>
@shreyas-goenka shreyas-goenka added this pull request to the merge queue Apr 18, 2024
Merged via the queue into main with commit eb9665d Apr 18, 2024
5 checks passed
@shreyas-goenka shreyas-goenka deleted the fix/better-auth-login-docs branch April 18, 2024 12:02
pietern added a commit that referenced this pull request Apr 23, 2024
@pietern
Release v0.218.0
29425f5 
This release marks the general availability of Databricks Asset Bundles.

CLI:
 * Publish Docker images ([#1353](#1353)).
 * Add support for multi-arch Docker images ([#1362](#1362)).
 * Do not prefill https:// in prompt for Databricks Host ([#1364](#1364)).
 * Add better documentation for the `auth login` command ([#1366](#1366)).
 * Add URLs for authentication documentation to the auth command help ([#1365](#1365)).

Bundles:
 * Fix compute override for foreach tasks ([#1357](#1357)).
 * Transform artifact files source patterns in build not upload stage ([#1359](#1359)).
 * Convert between integer and float in normalization ([#1371](#1371)).
 * Disable locking for development mode ([#1302](#1302)).
 * Resolve variable references inside variable lookup fields ([#1368](#1368)).
 * Added validate mutator to surface additional bundle warnings ([#1352](#1352)).
 * Upgrade terraform-provider-databricks to 1.40.0 ([#1376](#1376)).
 * Print host in `bundle validate` when passed via profile or environment variables ([#1378](#1378)).
 * Cleanup remote file path on bundle destroy ([#1374](#1374)).
 * Add docs URL for `run_as` in error message ([#1381](#1381)).
 * Enable job queueing by default ([#1385](#1385)).
 * Added support for job environments ([#1379](#1379)).
 * Processing and completion of positional args to bundle run ([#1120](#1120)).
 * Add legacy option for `run_as` ([#1384](#1384)).

API Changes:
 * Changed `databricks lakehouse-monitors cancel-refresh` command with new required argument order.
 * Changed `databricks lakehouse-monitors create` command with new required argument order.
 * Changed `databricks lakehouse-monitors delete` command with new required argument order.
 * Changed `databricks lakehouse-monitors get` command with new required argument order.
 * Changed `databricks lakehouse-monitors get-refresh` command with new required argument order.
 * Changed `databricks lakehouse-monitors list-refreshes` command with new required argument order.
 * Changed `databricks lakehouse-monitors run-refresh` command with new required argument order.
 * Changed `databricks lakehouse-monitors update` command with new required argument order.
 * Changed `databricks account workspace-assignment update` command to return response.

OpenAPI commit 94684175b8bd65f8701f89729351f8069e8309c9 (2024-04-11)

Dependency updates:
 * Bump github.com/databricks/databricks-sdk-go from 0.37.0 to 0.38.0 ([#1361](#1361)).
 * Bump golang.org/x/net from 0.22.0 to 0.23.0 ([#1380](#1380)).
@pietern pietern mentioned this pull request Apr 23, 2024
Merged
github-merge-queue bot pushed a commit that referenced this pull request Apr 23, 2024
@pietern
Release v0.218.0 (#1391)
27d35d5 
This release marks the general availability of Databricks Asset Bundles.

CLI:
* Publish Docker images
([#1353](#1353)).
* Add support for multi-arch Docker images
([#1362](#1362)).
* Do not prefill https:// in prompt for Databricks Host
([#1364](#1364)).
* Add better documentation for the `auth login` command
([#1366](#1366)).
* Add URLs for authentication documentation to the auth command help
([#1365](#1365)).

Bundles:
* Fix compute override for foreach tasks
([#1357](#1357)).
* Transform artifact files source patterns in build not upload stage
([#1359](#1359)).
* Convert between integer and float in normalization
([#1371](#1371)).
* Disable locking for development mode
([#1302](#1302)).
* Resolve variable references inside variable lookup fields
([#1368](#1368)).
* Added validate mutator to surface additional bundle warnings
([#1352](#1352)).
* Upgrade terraform-provider-databricks to 1.40.0
([#1376](#1376)).
* Print host in `bundle validate` when passed via profile or environment
variables ([#1378](#1378)).
* Cleanup remote file path on bundle destroy
([#1374](#1374)).
* Add docs URL for `run_as` in error message
([#1381](#1381)).
* Enable job queueing by default
([#1385](#1385)).
* Added support for job environments
([#1379](#1379)).
* Processing and completion of positional args to bundle run
([#1120](#1120)).
* Add legacy option for `run_as`
([#1384](#1384)).

API Changes:
* Changed `databricks lakehouse-monitors cancel-refresh` command with
new required argument order.
* Changed `databricks lakehouse-monitors create` command with new
required argument order.
* Changed `databricks lakehouse-monitors delete` command with new
required argument order.
* Changed `databricks lakehouse-monitors get` command with new required
argument order.
* Changed `databricks lakehouse-monitors get-refresh` command with new
required argument order.
* Changed `databricks lakehouse-monitors list-refreshes` command with
new required argument order.
* Changed `databricks lakehouse-monitors run-refresh` command with new
required argument order.
* Changed `databricks lakehouse-monitors update` command with new
required argument order.
* Changed `databricks account workspace-assignment update` command to
return response.

OpenAPI commit 94684175b8bd65f8701f89729351f8069e8309c9 (2024-04-11)

Dependency updates:
* Bump github.com/databricks/databricks-sdk-go from 0.37.0 to 0.38.0
([#1361](#1361)).
* Bump golang.org/x/net from 0.22.0 to 0.23.0
([#1380](#1380)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pietern pietern pietern approved these changes

@mgyucht mgyucht Awaiting requested review from mgyucht

@andrewnester andrewnester Awaiting requested review from andrewnester

@PaulCornellDB PaulCornellDB Awaiting requested review from PaulCornellDB

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@shreyas-goenka @PaulCornellDB @pietern