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.

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

Add bundle generate variant for dashboards #1847

Merged
merged 50 commits into from
Oct 29, 2024
Merged

Add bundle generate variant for dashboards #1847

merged 50 commits into from
Oct 29, 2024

Conversation

pietern
Copy link
Contributor

@pietern pietern commented Oct 21, 2024

Changes

This change adds the databricks bundle generate dashboard command.

The command requires one of three flags:

  • --existing-id to generate configuration for an existing dashboard by its ID.
  • --existing-path to generate configuration for an existing dashboard by its path in the workspace file system.
  • --resource to generate the .lvdash.json dashboard file for a dashboard that's already defined in the bundle. This option does not impact the YAML configuration.

A typical workflow could look like this:

  1. Use the command with --existing-id or --existing-path for a starting point
  2. Run bundle deploy to deploy a copy of the dashboard
  3. Run bundle open to open this copy in your browser
  4. Navigate to the draft mode and make modifications
  5. Run bundle generate dashboard with --resource to update the local .lvdash.json file with the remote modifications

Tests

@pietern pietern temporarily deployed to test-trigger-is October 28, 2024 16:15 — with GitHub Actions Inactive
@pietern pietern temporarily deployed to test-trigger-is October 29, 2024 08:16 — with GitHub Actions Inactive
Base automatically changed from dashboards to main October 29, 2024 09:17
@pietern pietern marked this pull request as ready for review October 29, 2024 09:18
@pietern pietern temporarily deployed to test-trigger-is October 29, 2024 09:18 — with GitHub Actions Inactive
@eng-dev-ecosystem-bot
Copy link
Collaborator

Test Details: go/deco-tests/11571905105

@pietern pietern added this pull request to the merge queue Oct 29, 2024
Merged via the queue into main with commit 1896b09 Oct 29, 2024
8 checks passed
@pietern pietern deleted the dashboards-generate branch October 29, 2024 11:59
andrewnester added a commit that referenced this pull request Oct 30, 2024
New features for Databricks Asset Bundles:
This release adds support for managing AI/BI dashboards as part of your bundle configuration. The `bundle generate` command is updated to support producing dashboard bundle configuration as well as dashboard payloads.
You can find an example configuration and walkthrough at https://github.com/databricks/bundle-examples/tree/main/knowledge_base/dashboard_nyc_taxi

Bundles:
 * Add support for AI/BI dashboards ([#1743](#1743)).
 * Added validator for folder permissions ([#1824](#1824)).
 * Add bundle generate variant for dashboards ([#1847](#1847)).
 * Use SetPermissions instead of UpdatePermissions when setting folder permissions based on top-level ones ([#1822](#1822)).

Internal:
 * Attempt to reduce test flakiness on Windows ([#1845](#1845)).
 * Reuse resource resolution code for the run command ([#1858](#1858)).
 * [Internal] Automatically trigger integration tests on PR ([#1857](#1857)).
 * Add privacy notice to README ([#1841](#1841)).
 * [Internal] Add test instructions for external contributors ([#1863](#1863)).
 * Add `libs/dyn/jsonsaver` ([#1862](#1862)).

Dependency updates:
 * Bump github.com/fatih/color from 1.17.0 to 1.18.0 ([#1861](#1861)).
github-merge-queue bot pushed a commit that referenced this pull request Oct 30, 2024
**New features for Databricks Asset Bundles:**

This release adds support for managing AI/BI dashboards as part of your
bundle configuration. The `bundle generate` command is updated to
support producing dashboard bundle configuration as well as a serialized
JSON representation of the dashboard.
You can find an example configuration and walkthrough at
https://github.com/databricks/bundle-examples/tree/main/knowledge_base/dashboard_nyc_taxi

CLI:
* Add privacy notice to README
([#1841](#1841)).

Bundles:
* Add support for AI/BI dashboards
([#1743](#1743)).
* Added validator for folder permissions
([#1824](#1824)).
* Add bundle generate variant for dashboards
([#1847](#1847)).
* Use SetPermissions instead of UpdatePermissions when setting folder
permissions based on top-level ones
([#1822](#1822)).

Internal:
* Attempt to reduce test flakiness on Windows
([#1845](#1845)).
* Reuse resource resolution code for the run command
([#1858](#1858)).
* [Internal] Automatically trigger integration tests on PR
([#1857](#1857)).
* [Internal] Add test instructions for external contributors
([#1863](#1863)).
* Add `libs/dyn/jsonsaver`
([#1862](#1862)).


Dependency updates:
* Bump github.com/fatih/color from 1.17.0 to 1.18.0
([#1861](#1861)).

---------

Co-authored-by: Pieter Noordhuis <pieter.noordhuis@databricks.com>
Sign up for free to 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.

3 participants