Move bundle schema update to an internal module by shreyas-goenka · Pull Request #1012 · databricks/cli

shreyas-goenka · 2023-11-27T11:42:43Z

Changes

This PR:

Move code to load bundle JSON Schema descriptions from the OpenAPI spec to an internal Go module
Remove command line flags from the bundle schema command. These flags were meant for internal processes and at no point were meant for customer use.
Regenerate bundle_descriptions.json
Add support for bundle: "deprecated". The environments field is tagged as deprecated in this PR and consequently will no longer be a part of the bundle schema.

Tests

Tested by regenerating the CLI against its current OpenAPI spec (as defined in __openapi_sha). The bundle_descriptions.json in this PR was generated from the code generator.

Manually checked that the autocompletion / descriptions from the new bundle schema are correct.

pietern · 2023-11-27T15:00:51Z

@@ -36,30 +51,45 @@
 }
 }
 },
- "targets": {
+ "environments": {


What happened here? It looks like the environments block got reinstated with empty docs.

This is expected. enviroments was renamed to -> targets here manually https://github.com/databricks/cli/pull/670/files#diff-2b39aa846db6105db22d39143a8474f599cd77a4085521636c97f0949a82f73a
Generating the docs manually from the bundle Go struct also generated docs for for enviroments. However this does not make a difference for the final generated enviroments schema.

Please mask it out. I'd rather have a squiggly line on environments than valid autocompletion.

Done. I have marked enviroments as "deprecated". From this point onwards it will not generated as part of the bundle schema.

## Changes Introduced in #1007 but doesn't work well yet. This will be automated again as part of #1012.

…Databricks OpenAPI specification (#1033) ## Changes This PR adds documentation for positional arguments in commands that are generated from the openapi spec. Note: the changes to `.gitattributes` will be revert / properly fixed in #1012

pietern

Please TAL at the comment in the environments thread.

CLI: * Add documentation for positional args in commands generated from the Databricks OpenAPI specification ([#1033](#1033)). * Ask for host when .databrickscfg doesn't exist ([#1041](#1041)). * Add list of supported values for flags that represent an enum field ([#1036](#1036)). Bundles: * Fix panic when bundle auth resolution fails ([#1002](#1002)). * Add versioning for bundle templates ([#972](#972)). * Add support for conditional prompting in bundle init ([#971](#971)). * Pass parameters to task when run with `--python-params` and `python_wheel_wrapper` is true ([#1037](#1037)). * Change default_python template to auto-update version on each wheel build ([#1034](#1034)). Internal: * Rewrite the friendly log handler ([#1038](#1038)). * Move bundle schema update to an internal module ([#1012](#1012)). Dependency updates: * Bump github.com/databricks/databricks-sdk-go from 0.26.0 to 0.26.1 ([#1040](#1040)).

## Changes Introduced in #1007 but doesn't work well yet. This will be automated again as part of #1012.

…Databricks OpenAPI specification (#1033) ## Changes This PR adds documentation for positional arguments in commands that are generated from the openapi spec. Note: the changes to `.gitattributes` will be revert / properly fixed in #1012

## Changes This PR: 1. Move code to load bundle JSON Schema descriptions from the OpenAPI spec to an internal Go module 2. Remove command line flags from the `bundle schema` command. These flags were meant for internal processes and at no point were meant for customer use. 3. Regenerate `bundle_descriptions.json` 4. Add support for `bundle: "deprecated"`. The `environments` field is tagged as deprecated in this PR and consequently will no longer be a part of the bundle schema. ## Tests Tested by regenerating the CLI against its current OpenAPI spec (as defined in `__openapi_sha`). The `bundle_descriptions.json` in this PR was generated from the code generator. Manually checked that the autocompletion / descriptions from the new bundle schema are correct.

CLI: * Add documentation for positional args in commands generated from the Databricks OpenAPI specification ([#1033](#1033)). * Ask for host when .databrickscfg doesn't exist ([#1041](#1041)). * Add list of supported values for flags that represent an enum field ([#1036](#1036)). Bundles: * Fix panic when bundle auth resolution fails ([#1002](#1002)). * Add versioning for bundle templates ([#972](#972)). * Add support for conditional prompting in bundle init ([#971](#971)). * Pass parameters to task when run with `--python-params` and `python_wheel_wrapper` is true ([#1037](#1037)). * Change default_python template to auto-update version on each wheel build ([#1034](#1034)). Internal: * Rewrite the friendly log handler ([#1038](#1038)). * Move bundle schema update to an internal module ([#1012](#1012)). Dependency updates: * Bump github.com/databricks/databricks-sdk-go from 0.26.0 to 0.26.1 ([#1040](#1040)).

shreyas-goenka added 11 commits November 27, 2023 12:42

Make command for bundle descriptions update an internal module
87d992a

remove test generation
317b301

-
ce2cfae

fix autogenerated code
31183d2

update attributes
0466cbc

-
2d9f153

-
8d6e856

-
6f6ab06

update sop
d6a3f2e

add generated descriptions to the schema file
53364d8

-
a8274f7

shreyas-goenka requested review from andrewnester and pietern November 27, 2023 13:03

shreyas-goenka marked this pull request as ready for review November 27, 2023 13:33

shreyas-goenka changed the title ~~Make command for bundle descriptions update an internal module~~Move bundle schema update to an internal moduleNov 27, 2023

shreyas-goenka mentioned this pull request Nov 27, 2023
Fix bundle schema documentation generation #1006
Closed

pietern reviewed Nov 27, 2023
View reviewed changes

remove go.mod
03c2238

shreyas-goenka requested a review from pietern November 27, 2023 16:59

shreyas-goenka mentioned this pull request Nov 29, 2023
Revert automation for bundle schema documentation generation #1018
Merged

github-merge-queueBot pushed a commit that referenced this pull request Nov 29, 2023
Revert automation for bundle schema documentation generation (#1018)
5f88af5
## Changes Introduced in #1007 but doesn't work well yet. This will be automated again as part of #1012.

shreyas-goenka mentioned this pull request Nov 30, 2023
Add documentation for positional args in commands generated from the Databricks OpenAPI specification #1033
Merged

shreyas-goenka added 2 commits December 6, 2023 13:51

merge
52a6e8e

regenerate
441da27

pietern reviewed Dec 6, 2023
View reviewed changes

mark enviromnets as deprecated
32719ab

shreyas-goenka requested a review from pietern December 6, 2023 10:02

pietern approved these changes Dec 6, 2023
View reviewed changes

shreyas-goenka added this pull request to the merge queue Dec 6, 2023

Merged via the queue into main with commit 6002f49Dec 6, 2023

shreyas-goenka deleted the make-docs-internal branch December 6, 2023 10:51

andrewnester mentioned this pull request Dec 6, 2023
Release v0.210.2 #1044
Merged

denik pushed a commit that referenced this pull request May 20, 2026
Revert automation for bundle schema documentation generation (#1018)
82e394c
## Changes Introduced in #1007 but doesn't work well yet. This will be automated again as part of #1012.

Navigation Menu

Uh oh!

Move bundle schema update to an internal module - #1012

Move bundle schema update to an internal module#1012
shreyas-goenka merged 15 commits into
mainfrom
make-docs-internal

shreyas-goenka commented Nov 27, 2023•
edited
Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pieternNov 27, 2023

Uh oh!

shreyas-goenkaNov 27, 2023

Uh oh!

pieternDec 6, 2023

Uh oh!

shreyas-goenkaDec 6, 2023

Uh oh!

pietern left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

shreyas-goenka commented Nov 27, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Tests

Uh oh!

Uh oh!

Uh oh!

Uh oh!

pieternNov 27, 2023

Choose a reason for hiding this comment

Uh oh!

shreyas-goenkaNov 27, 2023

Choose a reason for hiding this comment

Uh oh!

pieternDec 6, 2023

Choose a reason for hiding this comment

Uh oh!

shreyas-goenkaDec 6, 2023

Choose a reason for hiding this comment

Uh oh!

pietern left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

shreyas-goenka commented Nov 27, 2023•
edited
Loading