Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

Feature request: native bundle variable substitution in explicitly selected files

未关闭
  • 哪里不对？
#7,100 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
go
领域
cli

调研方向

Start by reading the bundle configuration and deployment staging entry points, then trace how target variables are resolved and applied to native bundle configuration. The issue does not name specific files or tests; identify the relevant implementation and tests for file selection, rendering, and staging. Done means an opt-in workflow renders selected files from the resolved target context without modifying sources and covers the requested errors, escaping, sensitive values, and notebook behavior.

由索引模型根据 Issue 内容生成。

描述

Feature request

Support opt-in deployment-time substitution of bundle variables in additional files and directories, using the same resolved context as native bundle configuration.

For example, a bundle could explicitly select SQL migrations, JSON/YAML configuration files, and notebook sources containing ${var.<name>}. The CLI would prepare rendered copies for deployment or for use by an external deployment step.

Example use case

The bundle defines catalog and schema variables, with different values per target. A separate SQL file contains:

CREATE TABLE IF NOT EXISTS `${var.target_catalog}`.`${var.target_schema}`.example (
  id BIGINT
);

A JSON payload contains:

{
  "catalog": "${var.target_catalog}",
  "schema": "${var.target_schema}"
}

We would like to select these files by path, directory, or glob and have Databricks apply native variable resolution when preparing them for the selected target.

Current workaround and cost

We maintain a separate renderer in a deployment wrapper. It gets values from bundle validate -o json, substitutes them into additional files, and restores the working tree afterward.

This duplicates file-rendering and lifecycle work. It also couples the wrapper to validation-output redaction: with UC secrets present, unrelated string variable values are redacted even though native deployment has the actual values internally.

Reading defaults and resolving overrides ourselves would create a second implementation of Databricks bundle semantics. We want the CLI to own resolution.

Requested capability
  • Explicitly opt in files, directories, or globs; ordinary synchronized files should keep their current behavior by default.
  • Use the selected target's native resolution, including shared configuration, existing variable precedence, lookups, and substitutions.
  • Prepare rendered copies without modifying source files in the working tree.
  • Offer the rendered files through deployment staging and/or an output directory usable by external pre/post-deployment steps. A deployment-only upload transform would not cover SQL migrations executed by another tool.
  • Report unresolved references with file locations and provide a way to keep literal placeholder syntax.
  • Define escaping and type behavior for supported formats. For .ipynb, substitute cell source without rewriting outputs or metadata.
  • Define sensitive-value handling so substitutions cannot inadvertently appear in logs or source control; document any restrictions.

The configuration key and command shape are up to the maintainers. The core request is reuse of the native resolved bundle context for explicitly selected file contents.

Benefit

This would let consumers keep a single source of truth for target-specific values, reduce custom renderers and Git restoration logic, and avoid depending on display-output redaction for file preparation.

Native file rendering would solve the payload-preparation portion of our wrapper. External SQL execution would still need a supported way to obtain its non-secret connection settings, such as the warehouse ID.

Related issue

#6000 describes a related JSON/SQL substitution need for Genie. This request is broader: explicitly selected file contents and rendered output that external deployment steps can consume.

If a supported workflow already provides this capability, a pointer to it would be appreciated.

主要语言
Go
星标
409
派生
253
平均合并
1 天 14 小时
30 天内合并 PR
208

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

databricks/cli 的其他 Issue

查看 databricks/cli 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。