Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Feature request: native bundle variable substitution in explicitly selected files

Abierto
  • ¿Algo no está bien?
#7,100 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
go
Área
cli

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Go
Estrellas
409
Forks
253
Merge medio
1 d 11 h
PR fusionados (30 d)
212

Preparar el entorno

  • Incluye un Dockerfile o un archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de databricks/cli

Todos los issues de databricks/cli

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.