Document Aspire 17 required-parameter migration

未关闭
#2,114 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 2 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
68/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
csharp, typescript
领域
documentation

调研方向

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.

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

描述

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.

主要语言
MDX
星标
202
派生
99
平均合并
2 天 10 小时
30 天内合并 PR
97

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

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

microsoft/aspire.dev 的其他 Issue

查看 microsoft/aspire.dev 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

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