Uh oh!
There was an error while loading. Please reload this page.
Add agent files to DABs templates - #5996
Merged
Merged
Conversation
Generated DAB projects now include an AGENTS.md with project layout, the common bundle CLI workflow (validate/deploy/run/summary), and conventions, plus a CLAUDE.md that imports it via @AGENTS.md so Claude Code and tools using the AGENTS.md convention share one source of truth. Added to the default, default-sql, default-scala, and dbt-sql template bodies, which covers all built-in templates (default-python, default-minimal, lakeflow-pipelines, and pydabs share the default body). Co-authored-by: Isaac
…templates Update the remaining template files that referred to the product by its former name: the databricks.yml header comments (default, default-sql, default-scala bodies), the dbt_project.yml comment, and the default-minimal welcome message. Co-authored-by: Isaac
Replace the verbose per-template AGENTS.md with the short version originally used in experimental/aitools (removed in c8d825c): point agents at the databricks skill, explain how to install agent skills (databricks aitools install), and leave a placeholder for project-specific instructions. Inlining all instructions is a non-goal. Co-authored-by: Isaac
Reword the section to "Use the Databricks Agent Skills": read the core databricks skill, reach for the product skills it links to (databricks-jobs, databricks-pipelines, databricks-apps), and install them with databricks aitools install. Regenerate template goldens. Co-authored-by: Isaac
# Conflicts:
# acceptance/bundle/templates/default-minimal/output.txt
# acceptance/bundle/templates/default-minimal/output/my_default_minimal/databricks.yml
# acceptance/bundle/templates/default-python/classic/output/my_default_python/databricks.yml
# acceptance/bundle/templates/default-python/serverless/output/my_default_python/databricks.yml
# acceptance/bundle/templates/default-scala/output/my_default_scala/databricks.yml
# acceptance/bundle/templates/default-sql/output/my_default_sql/databricks.yml
# acceptance/bundle/templates/lakeflow-pipelines/python/output/my_lakeflow_pipelines/databricks.yml
# acceptance/bundle/templates/lakeflow-pipelines/sql/output/my_lakeflow_pipelines/databricks.yml
# acceptance/bundle/templates/pydabs/init-classic/output/my_pydabs/databricks.yml
# acceptance/bundle/templates/telemetry/default-python/out.databricks.yml
# acceptance/bundle/templates/telemetry/default-sql/out.databricks.yml
# libs/template/templates/default-minimal/databricks_template_schema.json
# libs/template/templates/default-scala/template/{{.project_name}}/databricks.yml.tmpl
# libs/template/templates/default-sql/template/{{.project_name}}/databricks.yml.tmpl
# libs/template/templates/default/template/{{.project_name}}/databricks.yml.tmplPoint coding agents at Databricks AI Tools: read the databricks-core skill, and install via `databricks aitools install` if it's missing. CLAUDE.md is a one-line @AGENTS.md include. Decided at the DABs core meeting. Co-authored-by: Isaac
Co-authored-by: Isaac
| @@ -0,0 +1,33 @@ | |||
| {{- /* | |||
ContributorAuthor
There was a problem hiding this comment.
This file is repeated a few times now, as a followup I want to look into a clean way to avoid the duplication. That will require a change in the templating code.
Contributor
There was a problem hiding this comment.
The default-*/ templates already pick up everything from default/ so you only need to duplicate dbt-sql
ContributorAuthor
There was a problem hiding this comment.
Unfortunately, default-sql and default-scala are also special right now.
Collaborator
Integration test reportCommit: d23199c
8 interesting tests: 4 SKIP, 3 KNOWN, 1 RECOVERED
Top 7 slowest tests (at least 2 minutes):
|
The lakeflow-pipelines template reuses default via template_dir, so
projects initialized by the pipelines/{init,e2e} acceptance tests now
emit AGENTS.md and CLAUDE.md; add them to those tests' goldens.
Co-authored-by: Isaac1 task
janniklasrose
approved these changes
Jul 21, 2026
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Jan N Rose <janniklas.rose@gmail.com>
lennartkats-db
enabled auto-merge
July 22, 2026 08:50
# Conflicts: # acceptance/bundle/templates/default-minimal/python/output/my_default_minimal/AGENTS.md # acceptance/bundle/templates/default-minimal/python/output/my_default_minimal/CLAUDE.md
main split the default-minimal acceptance test into python/sql/skip variants; regenerate each variant's goldens to include the AGENTS.md and CLAUDE.md that default-minimal inherits from the default template. Co-authored-by: Isaac
…ent-files-in-template
Uh oh!
There was an error while loading. Please reload this page.
deco-sdk-taggingBot
added a commit
that referenced
this pull request
Jul 22, 2026
## Release v1.9.0 ### CLI * `databricks auth profiles` no longer stalls on an unreachable workspace and instead fails validation after 5 seconds per host ([#5928](#5928)). * Fixed `databricks fs rm -r` failing on UC Volumes backed by GCS when a directory becomes empty during recursive deletion ([#5958](#5958)). * You can now ask questions about your data directly from the CLI with `databricks genie ask "..."`. Genie answers natural-language questions ("what were total sales last month?", "which tables are in the sales catalog?"), runs the query inside Databricks, and renders the answer in the terminal. This promotes the former `databricks experimental genie ask` command; the experimental alias still works but is deprecated and will be removed in a future release ([#6010](#6010)). ### Bundles * `bundle validate` now reports a clear error when a `sql_warehouse` is missing a `name` (including whitespace-only names), and a warning when a grant is missing a `principal` ([#5818](#5818)). * Bundle templates now scaffold an `AGENTS.md` that points coding agents at Databricks AI Tools, alongside a minimal `CLAUDE.md` that includes it via `@AGENTS.md` ([#5996](#5996)). * `bundle generate job` can now download workspace files referenced by `spark_python_task`, rewriting them to a relative path like it already does for notebooks. This is opt-in via the `--download-spark-python-files` flag ([#5799](#5799)). * Simplified the `default-minimal` bundle template and added an alias `databricks bundle init empty` ([#5899](#5899)). * Add support for the `instance_pools` resource type in Declarative Automation Bundles. Instance pools are only supported in direct deployment mode. * Do not emit "unknown field" warnings for YAML anchors grouped in a list or map, matching the existing suppression for standalone anchors ([#5975](#5975)). * Provide an actionable error message if databricks.yml is missing or DATABRICKS_BUNDLE_ROOT is invalid ([#5953](#5953)). ### Dependency Updates * Bump `github.com/databricks/databricks-sdk-go` from v0.154.0 to v0.160.0 ([#5982](#5982)). * Bump Terraform provider from v1.121.0 to v1.122.0 ([#5977](#5977)).
eng-dev-ecosystem-bot
commented
Jul 22, 2026
Collaborator
Integration test reportCommit: 7f23bd2
97 interesting tests: 71 FAIL, 18 flaky, 5 KNOWN, 2 SKIP, 1 RECOVERED
Top 50 slowest tests (at least 2 minutes):
|
ronaldz-db pushed a commit
to ronaldz-db/cli
that referenced
this pull request
Jul 23, 2026
## Changes Stacked on databricks#5996. The four standalone templates (`default`, `default-scala`, `default-sql`, `dbt-sql`) carried byte-identical `AGENTS.md`/`CLAUDE.md` files. This moves the content into one shared library (`templates/common/library`) that `newRenderer` parses into every template's namespace, and reduces each template's files to one-line `{{template}}` stubs. - [x] target branch must be set to `main` before merging ## Tests Template and pipelines acceptance goldens are unchanged; `task test-update-templates` passes with no diff.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Add an
AGENTS.mdto the bundle templates (default,default-scala,default-sql,dbt-sql, plus the templates that reusedefault). It points coding agents at Databricks AI Tools: read thedatabricks-coreskill first, and install viadatabricks aitools installif it's missing. A one-lineCLAUDE.mdincludes it via@AGENTS.md.Why
We'd like to help AI agents in new projects via Databricks AI Tools.
Tests
Regenerated the template acceptance goldens;
task test-update-templatespasses.