steve/databricks-cli
steve
/
databricks-cli
mirror of https://github.com/databricks/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
databricks-cli/libs/template/templates/default-python/databricks_template_schema....

36 lines
1.6 KiB
JSON
Raw Normal View History

Add a foundation for built-in templates (#685) ## Changes This pull request extends the templating support in preparation of a new, default template (WIP, https://github.com/databricks/cli/pull/686): * builtin templates that can be initialized using e.g. `databricks bundle init default-python` * builtin templates are embedded into the executable using go's `embed` functionality, making sure they're co-versioned with the CLI * new helpers to get the workspace name, current user name, etc. help craft a complete template * (not enabled yet) when the user types `databricks bundle init` they can interactively select the `default-python` template And makes two tangentially related changes: * IsServicePrincipal now uses the "users" API rather than the "principals" API, since the latter is too slow for our purposes. * mode: prod no longer requires the 'target.prod.git' setting. It's hard to set that from a template. (Pieter is planning an overhaul of warnings support; this would be one of the first warnings we show.) The actual `default-python` template is maintained in a separate PR: https://github.com/databricks/cli/pull/686 ## Tests Unit tests, manual testing
2023-08-25 09:03:42 +00:00
{
Add welcome message to bundle templates (#907) ## 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. ```
2023-10-25 12:27:25 +00:00
"welcome_message": "\nWelcome to the sample Databricks Asset Bundle template! Please enter the following information to initialize your sample DAB.\n",
Add a foundation for built-in templates (#685) ## Changes This pull request extends the templating support in preparation of a new, default template (WIP, https://github.com/databricks/cli/pull/686): * builtin templates that can be initialized using e.g. `databricks bundle init default-python` * builtin templates are embedded into the executable using go's `embed` functionality, making sure they're co-versioned with the CLI * new helpers to get the workspace name, current user name, etc. help craft a complete template * (not enabled yet) when the user types `databricks bundle init` they can interactively select the `default-python` template And makes two tangentially related changes: * IsServicePrincipal now uses the "users" API rather than the "principals" API, since the latter is too slow for our purposes. * mode: prod no longer requires the 'target.prod.git' setting. It's hard to set that from a template. (Pieter is planning an overhaul of warnings support; this would be one of the first warnings we show.) The actual `default-python` template is maintained in a separate PR: https://github.com/databricks/cli/pull/686 ## Tests Unit tests, manual testing
2023-08-25 09:03:42 +00:00
"properties": {
"project_name": {
"type": "string",
"default": "my_project",
databricks bundle init template v2: optional stubs, DLT support (#700) ## Changes This follows up on https://github.com/databricks/cli/pull/686. This PR makes our stubs optional + it adds DLT stubs: ``` $ databricks bundle init Template to use [default-python]: default-python Unique name for this project [my_project]: my_project Include a stub (sample) notebook in 'my_project/src' [yes]: yes Include a stub (sample) DLT pipeline in 'my_project/src' [yes]: yes Include a stub (sample) Python package 'my_project/src' [yes]: yes ✨ Successfully initialized template ``` ## Tests Manual testing, matrix tests. --------- Co-authored-by: Andrew Nester <andrew.nester@databricks.com> Co-authored-by: PaulCornellDB <paul.cornell@databricks.com> Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>
2023-09-06 09:52:31 +00:00
"description": "Unique name for this project",
Add support for regex patterns in template schema (#768) ## Changes This PR introduces support for regex pattern validation in our custom jsonschema validator. This allows us to fail early if a user enters an invalid value for a field. For example, now this is what initializing the default template looks like with an invalid project name: ``` shreyas.goenka@THW32HFW6T bricks % cli bundle init Template to use [default-python]: Unique name for this project [my_project]: (_*_) Error: invalid value for project_name: (_*_). Must consist of letter and underscores only. ``` ## Tests New unit tests and manually.
2023-09-25 09:53:38 +00:00
"order": 1,
Improve the output of the `databricks bundle init` command (#795) 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>
2023-10-19 07:08:36 +00:00
"pattern": "^[A-Za-z0-9_]+$",
"pattern_match_failure_message": "Name must consist of letters, numbers, and underscores."
databricks bundle init template v2: optional stubs, DLT support (#700) ## Changes This follows up on https://github.com/databricks/cli/pull/686. This PR makes our stubs optional + it adds DLT stubs: ``` $ databricks bundle init Template to use [default-python]: default-python Unique name for this project [my_project]: my_project Include a stub (sample) notebook in 'my_project/src' [yes]: yes Include a stub (sample) DLT pipeline in 'my_project/src' [yes]: yes Include a stub (sample) Python package 'my_project/src' [yes]: yes ✨ Successfully initialized template ``` ## Tests Manual testing, matrix tests. --------- Co-authored-by: Andrew Nester <andrew.nester@databricks.com> Co-authored-by: PaulCornellDB <paul.cornell@databricks.com> Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>
2023-09-06 09:52:31 +00:00
},
"include_notebook": {
"type": "string",
"default": "yes",
Use enums for default python template (#765) ## Changes This PR changes schema to use the enum type for the default template yes/no questions. ## Tests Manually
2023-09-13 17:57:31 +00:00
"enum": ["yes", "no"],
Improve the output of the `databricks bundle init` command (#795) 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>
2023-10-19 07:08:36 +00:00
"description": "Include a stub (sample) notebook in '{{.project_name}}{{path_separator}}src'",
databricks bundle init template v2: optional stubs, DLT support (#700) ## Changes This follows up on https://github.com/databricks/cli/pull/686. This PR makes our stubs optional + it adds DLT stubs: ``` $ databricks bundle init Template to use [default-python]: default-python Unique name for this project [my_project]: my_project Include a stub (sample) notebook in 'my_project/src' [yes]: yes Include a stub (sample) DLT pipeline in 'my_project/src' [yes]: yes Include a stub (sample) Python package 'my_project/src' [yes]: yes ✨ Successfully initialized template ``` ## Tests Manual testing, matrix tests. --------- Co-authored-by: Andrew Nester <andrew.nester@databricks.com> Co-authored-by: PaulCornellDB <paul.cornell@databricks.com> Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>
2023-09-06 09:52:31 +00:00
"order": 2
},
"include_dlt": {
"type": "string",
"default": "yes",
Use enums for default python template (#765) ## Changes This PR changes schema to use the enum type for the default template yes/no questions. ## Tests Manually
2023-09-13 17:57:31 +00:00
"enum": ["yes", "no"],
Improve the output of the `databricks bundle init` command (#795) 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>
2023-10-19 07:08:36 +00:00
"description": "Include a stub (sample) Delta Live Tables pipeline in '{{.project_name}}{{path_separator}}src'",
databricks bundle init template v2: optional stubs, DLT support (#700) ## Changes This follows up on https://github.com/databricks/cli/pull/686. This PR makes our stubs optional + it adds DLT stubs: ``` $ databricks bundle init Template to use [default-python]: default-python Unique name for this project [my_project]: my_project Include a stub (sample) notebook in 'my_project/src' [yes]: yes Include a stub (sample) DLT pipeline in 'my_project/src' [yes]: yes Include a stub (sample) Python package 'my_project/src' [yes]: yes ✨ Successfully initialized template ``` ## Tests Manual testing, matrix tests. --------- Co-authored-by: Andrew Nester <andrew.nester@databricks.com> Co-authored-by: PaulCornellDB <paul.cornell@databricks.com> Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>
2023-09-06 09:52:31 +00:00
"order": 3
},
"include_python": {
"type": "string",
"default": "yes",
Use enums for default python template (#765) ## Changes This PR changes schema to use the enum type for the default template yes/no questions. ## Tests Manually
2023-09-13 17:57:31 +00:00
"enum": ["yes", "no"],
Improve the output of the `databricks bundle init` command (#795) 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>
2023-10-19 07:08:36 +00:00
"description": "Include a stub (sample) Python package in '{{.project_name}}{{path_separator}}src'",
databricks bundle init template v2: optional stubs, DLT support (#700) ## Changes This follows up on https://github.com/databricks/cli/pull/686. This PR makes our stubs optional + it adds DLT stubs: ``` $ databricks bundle init Template to use [default-python]: default-python Unique name for this project [my_project]: my_project Include a stub (sample) notebook in 'my_project/src' [yes]: yes Include a stub (sample) DLT pipeline in 'my_project/src' [yes]: yes Include a stub (sample) Python package 'my_project/src' [yes]: yes ✨ Successfully initialized template ``` ## Tests Manual testing, matrix tests. --------- Co-authored-by: Andrew Nester <andrew.nester@databricks.com> Co-authored-by: PaulCornellDB <paul.cornell@databricks.com> Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>
2023-09-06 09:52:31 +00:00
"order": 4
Add a foundation for built-in templates (#685) ## Changes This pull request extends the templating support in preparation of a new, default template (WIP, https://github.com/databricks/cli/pull/686): * builtin templates that can be initialized using e.g. `databricks bundle init default-python` * builtin templates are embedded into the executable using go's `embed` functionality, making sure they're co-versioned with the CLI * new helpers to get the workspace name, current user name, etc. help craft a complete template * (not enabled yet) when the user types `databricks bundle init` they can interactively select the `default-python` template And makes two tangentially related changes: * IsServicePrincipal now uses the "users" API rather than the "principals" API, since the latter is too slow for our purposes. * mode: prod no longer requires the 'target.prod.git' setting. It's hard to set that from a template. (Pieter is planning an overhaul of warnings support; this would be one of the first warnings we show.) The actual `default-python` template is maintained in a separate PR: https://github.com/databricks/cli/pull/686 ## Tests Unit tests, manual testing
2023-08-25 09:03:42 +00:00
}
Improve the output of the `databricks bundle init` command (#795) 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>
2023-10-19 07:08:36 +00:00
},
"success_message": "\n✨ Your new project has been created in the '{{.project_name}}' directory!\n\nPlease refer to the README.md of your project for further instructions on getting started.\nOr read the documentation on Databricks Asset Bundles at https://docs.databricks.com/dev-tools/bundles/index.html."
Add a foundation for built-in templates (#685) ## Changes This pull request extends the templating support in preparation of a new, default template (WIP, https://github.com/databricks/cli/pull/686): * builtin templates that can be initialized using e.g. `databricks bundle init default-python` * builtin templates are embedded into the executable using go's `embed` functionality, making sure they're co-versioned with the CLI * new helpers to get the workspace name, current user name, etc. help craft a complete template * (not enabled yet) when the user types `databricks bundle init` they can interactively select the `default-python` template And makes two tangentially related changes: * IsServicePrincipal now uses the "users" API rather than the "principals" API, since the latter is too slow for our purposes. * mode: prod no longer requires the 'target.prod.git' setting. It's hard to set that from a template. (Pieter is planning an overhaul of warnings support; this would be one of the first warnings we show.) The actual `default-python` template is maintained in a separate PR: https://github.com/databricks/cli/pull/686 ## Tests Unit tests, manual testing
2023-08-25 09:03:42 +00:00
}