Document Aspire 17 required-parameter migration

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

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
68/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
csharp, typescript
Área
documentation

Línea de trabajo

Read the existing troubleshooting guidance at docs/tips-and-known-issues.md#aspire-17-intentionally-empty-parameter-values and reconcile it with the merged implementation and linked Aspire changes. When the Aspire 17 release or migration page is added to the website's main tree, write the note there and link the existing external-parameters guidance. Cover required values and startup recovery, optional parameter behavior in C# and TypeScript, and the manifest publisher limitation; done means the migration guidance reflects current behavior without creating a standalone page.

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

Descripción

Add an Aspire 17 What's New migration note for the required-parameter change introduced by aspire#18108, including the interactive startup recovery in draft aspire#22124. The original report is aspire#21795.

Keep the required null/empty validation; this is migration guidance, not a request to revert it. Parameters are required by default, and an explicit "" no longer satisfies a required value. Cover ordinary, secret, and connection-string parameters.

The note should explain:

  • Supply a nonempty value for required parameters. When Dashboard interaction is available, missing required startup values can be supplied in Parameters; without interaction, initialization fails with a MissingParameterValueException naming the parameter.
  • If an empty or absent value is genuinely valid, use .WithOptional() in C# or .withOptional() in TypeScript. An explicit empty optional value remains ""; an unset optional value resolves to null and is omitted when used as an environment variable. Do not make required credentials optional just to suppress validation.
  • In TypeScript, omitting value or supplying value: null uses parameter configuration; it does not override a configured value with an empty string.
  • The manifest publisher does not currently support optional parameters. Do not present optionality as a workaround for required deployment values.

The draft's troubleshooting guidance has the examples and current behavior. Reconcile this note with the merged implementation before publication.

The website's complete main tree has no Aspire 17 release/migration page as of November 11, 2026. Add this to that page when it is created and link the existing external-parameters guidance; this follow-up does not require creating a standalone Aspire 17 page now. Website publication should not block the code fix.

Lenguaje dominante
MDX
Estrellas
202
Forks
99
Merge medio
2 d 10 h
PR fusionados (30 d)
97

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/aspire.dev

Todos los issues de microsoft/aspire.dev

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.