Document Aspire 17 required-parameter migration

Đang mở
  • Có gì không ổn?
#2,114 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
68/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
csharp, typescript
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
MDX
Star
202
Fork
99
Merge trung bình
2 ngày 10 giờ
Pull request đã merge (30 ngày)
97

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của microsoft/aspire.dev

Tất cả issue của microsoft/aspire.dev

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.