Skip to content

Automate the generation of bundle schema descriptions - #1007

Merged
shreyas-goenka merged 5 commits into
mainfrom
automate-docs-generation
Nov 27, 2023
Merged

Automate the generation of bundle schema descriptions#1007
shreyas-goenka merged 5 commits into
mainfrom
automate-docs-generation

Conversation

@shreyas-goenka

@shreyas-goenkashreyas-goenka commented Nov 23, 2023

Copy link
Copy Markdown
Contributor

Changes

This PR makes changes required to automatically update the bundle docs during the CLI release process. We rely on post_generate scripts that are executed after code generation with CWD as the CLI repo root.

The new output-file flag is introduced because stdout redirect does not work here and would otherwise require changes to our release automation CLI (deco CLI)

Tests

Manually. Regenerated the CLI and the descriptions were indeed generated for the CLI from the provided openapi spec.

@shreyas-goenkashreyas-goenka changed the title Automate bundle schema descriptions generationAutomate the generation of bundle schema descriptions from the Databricks OpenAPI specificationNov 23, 2023
Comment threadcmd/bundle/schema.go Outdated
Comment threadcmd/bundle/schema.go
@pieternpietern changed the title Automate the generation of bundle schema descriptions from the Databricks OpenAPI specificationAutomate the generation of bundle schema descriptionsNov 27, 2023
@shreyas-goenka
shreyas-goenka added this pull request to the merge queueNov 27, 2023
Merged via the queue into main with commit 96e9545Nov 27, 2023
@shreyas-goenka
shreyas-goenka deleted the automate-docs-generation branch November 27, 2023 10:47
github-merge-queueBot pushed a commit that referenced this pull request Nov 29, 2023
## Changes
Introduced in #1007 but doesn't work well yet. This will be automated
again as part of #1012.
denik pushed a commit that referenced this pull request May 20, 2026
## Changes
This PR makes changes required to automatically update the bundle docs
during the CLI release process. We rely on `post_generate` scripts that
are executed after code generation with CWD as the CLI repo root.
The new `output-file` flag is introduced because stdout redirect does
not work here and would otherwise require changes to our release
automation CLI (deco CLI)
## Tests
Manually. Regenerated the CLI and the descriptions were indeed generated
for the CLI from the provided openapi spec.
denik pushed a commit that referenced this pull request May 20, 2026
## Changes
Introduced in #1007 but doesn't work well yet. This will be automated
again as part of #1012.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@shreyas-goenka@pietern