Uh oh!
There was an error while loading. Please reload this page.
Use a shared AGENTS.md file for templates - #6017
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
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: IsaacThe four standalone templates (default, default-scala, default-sql,
dbt-sql) carried byte-identical AGENTS.md/CLAUDE.md files. Move the
content into a single shared library (templates/common/library) that
newRenderer parses into every template's namespace, and reduce each
template's files to one-line {{template}} stubs. Rendered output is
unchanged.
Co-authored-by: Isaaclennartkats-db
requested review from
janniklasrose, parthban-db and renaudhartert-dbJuly 21, 2026 19:54
Collaborator
Integration test reportCommit: b31e342
9 interesting tests: 4 SKIP, 3 KNOWN, 1 RECOVERED, 1 flaky
Top 18 slowest tests (at least 2 minutes):
|
Comment on lines
+78
to
+79
| // Parse the shared library before the template's own, so a same-named | ||
| // definition in the template's library takes precedence. |
Contributor
There was a problem hiding this comment.
Parse the shared library before the template's own, so a same-named definition in the template's library takes precedence.
would be good to assert this via at least a unit test
lennartkats-db added a commit
that referenced
this pull request
Jul 22, 2026
Assert that a template's own library definition takes precedence over a same-named definition in the shared library, per review feedback on #6017. Co-authored-by: Isaac
Assert that a template's own library definition takes precedence over a same-named definition in the shared library, per review feedback on #6017. Co-authored-by: Isaac
lennartkats-dbforce-pushed
the
agent-files-shared-template
branch
from
July 22, 2026 09:15
a9cb291 to
b355409Comparejanniklasrose
approved these changes
Jul 22, 2026
…mplate
# Conflicts:
# .nextchanges/bundles/agents-md-templates.md
# acceptance/bundle/templates/default-minimal/python/output/my_default_minimal/AGENTS.md
# acceptance/bundle/templates/default-minimal/python/output/my_default_minimal/CLAUDE.md
# libs/template/templates/dbt-sql/template/{{.project_name}}/AGENTS.md.tmpl
# libs/template/templates/dbt-sql/template/{{.project_name}}/CLAUDE.md.tmpl
# libs/template/templates/default-scala/template/{{.project_name}}/AGENTS.md.tmpl
# libs/template/templates/default-scala/template/{{.project_name}}/CLAUDE.md.tmpl
# libs/template/templates/default-sql/template/{{.project_name}}/AGENTS.md.tmpl
# libs/template/templates/default-sql/template/{{.project_name}}/CLAUDE.md.tmpl
# libs/template/templates/default/template/{{.project_name}}/AGENTS.md.tmpl
# libs/template/templates/default/template/{{.project_name}}/CLAUDE.md.tmpllennartkats-db
enabled auto-merge
July 22, 2026 11:26
Uh oh!
There was an error while loading. Please reload this page.
eng-dev-ecosystem-bot
commented
Jul 22, 2026
Collaborator
Integration test reportCommit: 82b62c4
76 interesting tests: 50 FAIL, 10 MISS, 8 flaky, 4 KNOWN, 2 RECOVERED, 2 SKIP
Top 50 slowest tests (at least 2 minutes):
|
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
Stacked on #5996. The four standalone templates (
default,default-scala,default-sql,dbt-sql) carried byte-identicalAGENTS.md/CLAUDE.mdfiles.This moves the content into one shared library (
templates/common/library)that
newRendererparses into every template's namespace, and reduces eachtemplate's files to one-line
{{template}}stubs.mainbefore mergingTests
Template and pipelines acceptance goldens are unchanged;
task test-update-templatespasses with no diff.