Skip to content

feat(app): Improved Install Flow Github - #141

Merged
MaximHammer merged 3 commits into
mainfrom
feature/app_github_install
Nov 16, 2026
Merged

MaximHammer merged 3 commits into
mainfrom
feature/app_github_install

Conversation

@MaximHammer

Copy link
Copy Markdown
Contributor

Improvements

  • Install from the Databricks UI: create the app straight from this GitHub. No extra tools are needed
  • Install with one command: after clone, databricks apps deploy --var warehouse_id= sets up the app with its SQL warehouse, user scopes and sharing, starts it and prints the URL. Before, it took a frontend build and two commands.
  • No Node.js needed anymore: the built frontend is now part of the repo, so no extra requirements or potential corporate access blockers
  • Works where admins only allow deployments from Git: add -t github and the app deploys the checked-out commit straight from GitHub.
  • Improved permissions check via "Grant and run" button before final job run: if the app's service principal can't read the data or write the results, the Review & run step can now run the needed GRANT statements as you and then start the run. "Copy SQL" is still there for people who aren't allowed to grant. Nothing changes/appears when the app already has access.

Trade-offs

  • The built frontend (frontend/dist, about 1.7 MB) is committed. After each frontend change, run make frontend and commit the result; CI fails if you forget. Databricks Apps can build at deploy time, but that would need npm access in every customer workspace and Node.js for the CLI install locally

Tests

  • CLI install path, incl deploying with -t github.
  • UI install path
  • Grant and run: with the app's access really removed, the button granted exactly the needed privileges, and the report then ran successfully.
  • CI checks, docs build

MaximHammer and others added 2 commits November 15, 2026 15:25
The built frontend in frontend/dist is now committed, so deployments need
neither Node.js nor access to the npm registry. The app can be installed
from GitHub in the Databricks UI, and `databricks apps deploy` installs it
from a clone with one command. CI checks that the committed build matches
its source.

databricks.yml moves the workspace source into the dev target and adds a
github target that deploys the checked-out commit from GitHub, for
workspaces that only allow app deployments from Git.

The install docs cover the one-command and UI installs, upgrades and
switching to the github target. Node.js is no longer a requirement.

Co-authored-by: Isaac <no-reply@databricks.com>
…step

When the pre-flight check finds that the app's service principal lacks
access, Grant and run executes the generated GRANT statements as the
signed-in user and then starts the run. A statement the user may not run,
such as a catalog grant for a schema owner, doesn't stop the others; the
first failure is reported only if the service principal still lacks access
afterwards. Copy SQL stays for users who may not grant access.

Co-authored-by: Isaac <no-reply@databricks.com>
@codecov

codecov Bot commented Nov 15, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.32%. Comparing base (507bead) to head (1c9bf1e).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #141   +/-   ##
=======================================
  Coverage   90.32%   90.32%           
=======================================
  Files          68       68           
  Lines        6076     6076           
  Branches      759      759           
=======================================
  Hits         5488     5488           
  Misses        466      466           
  Partials      122      122           
Flag Coverage Δ
query_engine 86.83% <ø> (ø)
reporting 94.92% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

GitHub doesn't report the checks of a workflow that a paths filter skips,
so a required "Test the app" would block every PR that doesn't change the
app. The workflow now starts on every PR, and a new changes job checks
whether the PR touches apps/adhoc-reporting/ or app.yml. If it doesn't,
the test job is skipped, which GitHub counts as passing. Pushes to main
and manual runs behave as before.

The test job is skipped only for fork PRs, as before, and when the
changes job found no app changes. If a job it depends on fails, the tests
run, so a failing helper job can't pass the check untested.

Co-authored-by: Isaac <no-reply@databricks.com>
@MaximHammer
MaximHammer merged commit e37f502 into main Nov 16, 2026
11 checks passed

This branch was previously deployed

1 inactive deployment
e2e — 1c9bf1e3 Deployed Nov 16, 2026 by MaximHammer via Remove the PR's e2e bundle #78
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.

2 participants