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

config dump omits per-file overlays and inherited default-component-config

Abierto
  • ¿Algo no está bien?
#264 0 comentarios 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 2 días

@liunan-ms ya está trabajando en esto.

Desde el 20/8/2026.

  • #337 de @liunan-ms — abierto

Evaluación

Este issue todavía no se ha evaluado.

Descripción

bug GA blocker
Summary

azldev config dump presents itself as showing the "fully resolved project configuration", but it stops at the file-level merge and does not run the per-component resolver. As a result, two important sources of effective configuration are invisible in the dump even though builds honor them:

  1. overlay-files expansion — overlays loaded from overlays/*.overlay.toml (per-file overlay format, docs) never appear in components.<name>.overlays.
  2. Inherited default-component-config — fields injected from project/distro/component-group defaults never appear on the concrete component.

Downstream commands (build, render, prepare-sources, diff-sources) do run the resolver (applyInheritedDefaultsToComponent → ExpandResolvedOverlayFiles), so the artifacts they produce are correct. The gap is display-only, but it makes config dump misleading as an authoring/debugging aid.

Repro

Given a component using the per-file overlay format:

# base/comps/GraphicsMagick/GraphicsMagick.comp.toml
[components.GraphicsMagick]
overlay-files = ["overlays/*.overlay.toml"]

# base/comps/GraphicsMagick/overlays/0001-drop-libheif-build-dependency.overlay.toml
[metadata]
category = "azl-dep-missing-workaround"

[[overlays]]
type = "spec-remove-tag"
tag = "BuildRequires"
value = "libheif-devel"

Then:

$ azldev config dump -f json | jq '.components.GraphicsMagick.overlays'
null

But azldev component list -p GraphicsMagick -O json | jq '.[0].Overlays' shows the overlay, and azldev component render -p GraphicsMagick correctly removes the BuildRequires: libheif-devel line from the rendered spec.

Impact
  • Confuses users during authoring — a config that clearly "works" appears empty in the dump, prompting incorrect "my overlays aren't being applied" diagnoses.
  • Blocks the documented pattern of using azldev config dump -q -O json | jq ... for ad-hoc queries about effective component config (works today only for fields authored inline).
  • Makes the MCP config-dump tool less useful for coding agents that ask "what is the effective config for component X?".
Suggested fix

Add a flag to config dump that runs the per-component resolver before serialization. Some options:

  • A (preferred): azldev config dump --resolved (or --expand) — off by default to preserve today's round-trippable output; when set, iterates components through the resolver and replaces the components map with resolved copies (including expanded overlays and merged inherited defaults).
  • B: Always dump the resolved view; drop the round-trippability guarantee. Breaking change; probably not worth it.
  • C: Documentation-only — clarify in Long help and config-file.md that config dump is pre-resolver and point users to component list -O json for the resolved view. Cheapest fix but doesn't help the MCP-tool case.

Happy to send a PR for option A if the team agrees on the shape.

Related code
  • Dump entry point: internal/app/azldev/cmds/config/dump.go — marshals raw env.Config().
  • Resolver used by build/render/prepare-sources: internal/app/azldev/core/components/resolver.go — Resolver.FindComponents → getComponentFromNameAndSpecPath → applyInheritedDefaultsToComponent → ExpandResolvedOverlayFiles.
  • Feature introduced by PR #256 (per-file overlays / inherited overlay-files); this gap has existed since then.
Lenguaje dominante
Go
Estrellas
18
Forks
29
Merge medio
4 d 19 min
PR fusionados (30 d)
17

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

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 microsoft/azure-linux-dev-tools

Todos los issues de microsoft/azure-linux-dev-tools

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.