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 welcome message to bundle templates #907

Merged
merged 1 commit into from
Oct 25, 2023
Merged

Add welcome message to bundle templates #907

merged 1 commit into from
Oct 25, 2023

Conversation

shreyas-goenka
Copy link
Contributor

Changes

Adds a welcome_message field to templates and the default python template.

Tests

Manually.

Here's the output logs during template init now:

shreyas.goenka@THW32HFW6T bricks % cli bundle init                              
Template to use [default-python]: 

Welcome to the sample Databricks Asset Bundle template! Please enter the following information to initialize your sample DAB.

Unique name for this project [my_project]: abcde
Include a stub (sample) notebook in 'abcde/src': no
Include a stub (sample) Delta Live Tables pipeline in 'abcde/src': yes
Include a stub (sample) Python package in 'abcde/src': no

✨ Your new project has been created in the 'abcde' 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.

lennartkats-db
lennartkats-db reviewed Oct 23, 2023
View reviewed changes
Copy link
Contributor

@lennartkats-db lennartkats-db left a comment

Choose a reason for hiding this comment

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

Seems like a sensible addition. The MLOps template encoded this into the first question. It seems a bit cleaner to have first-class support. (Though it's not strictly necessary to have this.)

@shreyas-goenka
Copy link
Contributor Author

Agreed. The main motivation for this is indeed the mlops stack. I'm open to any suggestions (including no message) for the default-python template.

@lennartkats-db
Copy link
Contributor

I've previously considered adding a welcome message with some "\n\n"s in the first question of default-python template. But it didn't really seem necessary there.

@shreyas-goenka shreyas-goenka added this pull request to the merge queue Oct 25, 2023
Merged via the queue into main with commit a5815a0 Oct 25, 2023
4 checks passed
@shreyas-goenka shreyas-goenka deleted the template-welcome-message branch October 25, 2023 12:34
shreyas-goenka added a commit that referenced this pull request Nov 2, 2023
@shreyas-goenka
Release v0.209.0
10a4596 
CLI:
 * Fix URL for bundle template documentation ([#903](#903)).
 * Library to convert config.Value to Go struct ([#904](#904)).
 * Loading an empty file yields a nil ([#906](#906)).
 * Fix pattern validation for input properties ([#912](#912)).
 * Simplified code generation logic for handling path and request body parameters and JSON input ([#905](#905)).
 * Add support for multiline descriptions when using template enums ([#916](#916)).
 * Move bundle configuration filename code ([#917](#917)).
 * Add configuration normalization code ([#915](#915)).
 * Add welcome message to bundle templates ([#907](#907)).
 * Consolidate bundle configuration loader function ([#918](#918)).
 * Upload terraform state even if apply fails ([#923](#923)).
 * Use UserName instead of Id to check if identity used is a service principal ([#924](#924)).
 * `make snapshot` to build file in `.databricks/databricks` ([#927](#927)).
 * Persist deployment metadata in WSFS ([#845](#845)).
 * Run make fmt from fmt job ([#929](#929)).
 * Add override to support YAML inputs for apps ([#921](#921)).
 * Add GitHub issue templates ([#925](#925)).
 * Remove resolution of repo names against the Databricks Github account ([#940](#940)).
 * Fix metadata computation for empty bundle ([#939](#939)).

Bundles:
 * **FILL THIS IN MANUALLY BY MOVING RELEVANT ITEMS FROM ABOVE LIST**

Internal:
 * **FILL THIS IN MANUALLY BY MOVING RELEVANT ITEMS FROM ABOVE LIST**

API Changes:
 * Added `databricks apps` command group.
 * Added `databricks account network-policy` command group.

OpenAPI commit 5903bb39137fd76ac384b2044e425f9c56840e00 (2023-10-23)
Dependency updates:
 * Bump google.golang.org/grpc from 1.58.2 to 1.58.3 ([#920](#920)).
 * Bump the Go SDK in the CLI ([#919](#919)).
 * Bump Terraform provider to v1.29.0 ([#926](#926)).
 * Bump github.com/google/uuid from 1.3.1 to 1.4.0 ([#932](#932)).
@shreyas-goenka shreyas-goenka mentioned this pull request Nov 2, 2023
Merged
github-merge-queue bot pushed a commit that referenced this pull request Nov 2, 2023
@shreyas-goenka
Release v0.209.0 (#944)
51d41d6 
CLI:
* Added GitHub issue templates for CLI and DABs issues
([#925](#925)).
* Added override to support YAML inputs for apps
([#921](#921)).
* Simplified code generation logic for handling path and request body
parameters and JSON input
([#905](#905)).


Bundles:
* Fixed URL for bundle template documentation in init command help docs
([#903](#903)).
* Fixed pattern validation for input parameters in a bundle template
([#912](#912)).
* Fixed multiline description rendering for enum input parameters in
bundle templates ([#916](#916)).
* Changed production mode check for whether identity used is a service
principal to use UserName
([#924](#924)).
* Changed bundle deploy to upload partial terraform state even if
deployment fails ([#923](#923)).
* Added support for welcome messages to bundle templates
([#907](#907)).
* Added support for uploading bundle deployment metadata to WSFS
([#845](#845)).


Internal:
* Loading an empty yaml file yields a nil
([#906](#906)).
* Library to convert config.Value to Go struct
([#904](#904)).
* Remove default resolution of repo names against the Databricks Github
account([#940](#940)).
* Run make fmt from fmt job
([#929](#929)).
* `make snapshot` to build file in `.databricks/databricks`
([#927](#927)).
* Add configuration normalization code
([#915](#915)).

API Changes:
 * Added `databricks apps` command group.
 * Added `databricks account network-policy` command group.

Dependency updates:
* Bump Terraform provider from v1.28.0 to v1.29.0
([#926](#926)).
* Bump the Go SDK in the CLI from v0.23 to v0.24
([#919](#919)).
* Bump google.golang.org/grpc from 1.58.2 to 1.58.3
([#920](#920)).
* Bump github.com/google/uuid from 1.3.1 to 1.4.0
([#932](#932)).

OpenAPI commit 5903bb39137fd76ac384b2044e425f9c56840e00 (2023-10-23)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lennartkats-db lennartkats-db lennartkats-db left review comments

@pietern pietern pietern approved these changes

@andrewnester andrewnester Awaiting requested review from andrewnester

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

Successfully merging this pull request may close these issues.
3 participants
@shreyas-goenka @lennartkats-db @pietern