Improve the output of the `databricks bundle init` command by lennartkats-db · Pull Request #795 · databricks/cli

lennartkats-db · 2023-09-25T07:04:23Z

Improve the output of help, prompts, and so on for databricks bundle init and the default template.

Among other things, this PR adds support for a new welcome_message property that lets a template print a custom message on success:

$ databricks bundle init
Template to use [default-python]:
Unique name for this project [my_project]: lennart_project
Include a stub (sample) notebook in 'lennart_project/src': yes
Include a stub (sample) Delta Live Tables pipeline in 'lennart_project/src': yes
Include a stub (sample) Python package in 'lennart_project/src': yes
✨ Your new project has been created in the 'lennart_project' directory!
Please refer to the README.md of your project for further instructions on getting started.
Or read the documentation on Databricks Asset Bundles at https://docs.databricks.com/dev-tools/bundles/index.html.

Co-authored-by: shreyas-goenka <88374338+shreyas-goenka@users.noreply.github.com>

… tune-template-output

pietern

Nice work, LGTM!

@mingyu89 @vladimirk-db Once this is merged and released, you could consider adding a message to the MLops stack template. Nice to have a call to action after initialization.

@shreyas-goenka Can you do the final approval?

Remove snake_case comment

shreyas-goenka

LGTM with some minor comments. Approving to unblock.

Let's keep the cobra.MaximumNArgs(1) unless there's a good reason not to.

lennartkats-db · 2023-10-17T16:26:33Z

I'll followup, needed to prioritize some roadmap/serverless work.

… tune-template-output

CLI: * Fix rendering of streaming response ([#876](#876)). * Rename MLOps Stack to MLOps Stacks ([#881](#881)). * Support Python wheels larger than 10MB ([#879](#879)). * Improve the output of the `databricks bundle init` command ([#795](#795)). Bundles: * **FILL THIS IN MANUALLY BY MOVING RELEVANT ITEMS FROM ABOVE LIST** Internal: * **FILL THIS IN MANUALLY BY MOVING RELEVANT ITEMS FROM ABOVE LIST**

CLI: * Fix rendering of streaming response ([#876](#876)). Bundles: * Rename MLOps Stack to MLOps Stacks ([#881](#881)). * Support Python wheels larger than 10MB ([#879](#879)). * Improve the output of the `databricks bundle init` command ([#795](#795)).

## Changes This PR removes validation for default value against the regex pattern specified in a JSON schema at schema load time. This is required because #795 introduces parameterising the default value as a Go text template impling that the default value now does not necessarily have to match the pattern at schema load time. This will also unblock: databricks/mlops-stacks#108 Note, this does not remove runtime validation for input parameters right before template initialization, which happens here: https://github.com/databricks/cli/blob/fb32e78c9b9fb000ce898b8a60b0b47920f487d3/libs/template/materialize.go#L76 ## Tests Changes to existing test.

Improve the output of help, prompts, and so on for `databricks bundle init` and the default template. Among other things, this PR adds support for a new `welcome_message` property that lets a template print a custom message on success: ``` $ databricks bundle init Template to use [default-python]: Unique name for this project [my_project]: lennart_project Include a stub (sample) notebook in 'lennart_project/src': yes Include a stub (sample) Delta Live Tables pipeline in 'lennart_project/src': yes Include a stub (sample) Python package in 'lennart_project/src': yes ✨ Your new project has been created in the 'lennart_project' directory! Please refer to the README.md of your project for further instructions on getting started. Or read the documentation on Databricks Asset Bundles at https://docs.databricks.com/dev-tools/bundles/index.html. ``` --------- Co-authored-by: shreyas-goenka <88374338+shreyas-goenka@users.noreply.github.com>

CLI: * Fix rendering of streaming response ([#876](#876)). Bundles: * Rename MLOps Stack to MLOps Stacks ([#881](#881)). * Support Python wheels larger than 10MB ([#879](#879)). * Improve the output of the `databricks bundle init` command ([#795](#795)).

## Changes This PR removes validation for default value against the regex pattern specified in a JSON schema at schema load time. This is required because #795 introduces parameterising the default value as a Go text template impling that the default value now does not necessarily have to match the pattern at schema load time. This will also unblock: databricks/mlops-stacks#108 Note, this does not remove runtime validation for input parameters right before template initialization, which happens here: https://github.com/databricks/cli/blob/57416e110abb67d68fd41aebd4e02d5197584b20/libs/template/materialize.go#L76 ## Tests Changes to existing test.

lennartkats-db added 2 commits September 24, 2023 18:26

Improve the output of the databricks bundle init command
9564c05

Fix tests
def37e9

lennartkats-db force-pushed the tune-template-output branch from a4d7ad9 to def37e9Compare September 25, 2023 07:47

Merge remote-tracking branch 'databricks/main' into tune-template-output
2c06f43

lennartkats-db marked this pull request as ready for review September 25, 2023 08:32

lennartkats-db requested review from pietern and shreyas-goenka September 25, 2023 08:32

lennartkats-db changed the title ~~Improve the output of the 'databricks bundle init' command~~Improve the output of the databricks bundle init commandSep 25, 2023

shreyas-goenka requested changes Sep 26, 2023
View reviewed changes

Comment threadcmd/bundle/init.go Outdated
Comment threadlibs/jsonschema/schema.go Outdated
Comment threadlibs/template/renderer.go Outdated
Comment threadlibs/template/materialize.go

lennartkats-dband others added 5 commits September 27, 2023 09:12

Update libs/template/renderer.go
c1fd148
Co-authored-by: shreyas-goenka <88374338+shreyas-goenka@users.noreply.github.com>

Merge branch 'main' into tune-template-output
15de79a

Process review feedback
7c43512

Merge branch 'tune-template-output' of github.com:databricks/cli into…
580e95a
… tune-template-output

Validate after each prompt
f24e8df

lennartkats-db requested a review from shreyas-goenka October 2, 2023 07:49

pietern reviewed Oct 3, 2023
View reviewed changes

Comment threadlibs/jsonschema/extension.go Outdated

lennartkats-db added 2 commits October 3, 2023 13:17

Update extension.go
80dca13
Remove snake_case comment

Merge branch 'main' into tune-template-output
077110d

lennartkats-db enabled auto-merge October 3, 2023 11:17

shreyas-goenka disabled auto-merge October 3, 2023 11:39

shreyas-goenka approved these changes Oct 3, 2023
View reviewed changes

Comment threadcmd/bundle/init.go
Comment threadlibs/template/config_test.go
Comment threadlibs/template/config_test.go

Update init.go
02a8b77

lennartkats-db added 4 commits October 19, 2023 09:00

Duplicate test data
5b66be6

Merge branch 'tune-template-output' of github.com:databricks/cli into…
d8f9ce3
… tune-template-output

Cleanup
6ee9dc5

Merge remote-tracking branch 'databricks/main' into tune-template-output
b886c3d

lennartkats-db added this pull request to the merge queue Oct 19, 2023

Merged via the queue into main with commit a2ee8bbOct 19, 2023

lennartkats-db deleted the tune-template-output branch October 19, 2023 07:14

shreyas-goenka mentioned this pull request Oct 19, 2023
Release v0.208.1 #887
Merged

shreyas-goenka mentioned this pull request Nov 7, 2023
Remove validation for default value against pattern #959
Merged

Navigation Menu

Uh oh!

Improve the output of the `databricks bundle init` command - #795

Improve the output of the `databricks bundle init` command#795
lennartkats-db merged 15 commits into
mainfrom
tune-template-output

lennartkats-db commented Sep 25, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pietern left a comment

Uh oh!

Uh oh!

shreyas-goenka left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lennartkats-db commented Oct 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

lennartkats-db commented Sep 25, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pietern left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shreyas-goenka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lennartkats-db commented Oct 17, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants