Document Aspire 17 required-parameter migration

オープン
#2,114 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 2 日以内に返信

まだ誰も着手していません。

評価

難易度
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時間
マージ済み PR(30日)
97

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

microsoft/aspire.dev のほかの issue

microsoft/aspire.dev の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。