Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Breaking change]: WithCommand obsolete, call WithCommand overload that accepts CommandOptions instead #2888

Open
1 of 3 tasks
DamianEdwards opened this issue Mar 24, 2025 · 0 comments · May be fixed by #2870
Open
1 of 3 tasks

[Breaking change]: WithCommand obsolete, call WithCommand overload that accepts CommandOptions instead #2888

DamianEdwards opened this issue Mar 24, 2025 · 0 comments · May be fixed by #2870
Assignees
@IEvangelist
Labels
area-docs ⛓️‍💥 breaking-change Issues or PRs tracking breaking changes. doc-idea Indicates issues that are suggestions for new topics [org][type][category] in-pr Pri1 High priority, do before Pri2 and Pri3
Milestone
9.2

Comments

@DamianEdwards
Copy link
Member

Description

We obsoleted the WithCommand overload that takes lots of optional parameters and introduced a new overload that accepts an instance of CommandOptions.

Version

.NET Aspire 9.2

Previous behavior

The WithCommand method was not marked obsolete.

New behavior

The existing WithCommand overload is now obsolete. The new overload that accepts CommandOptions should be used instead.

Type of breaking change

  • Binary incompatible: Existing binaries might encounter a breaking change in behavior, such as failure to load or execute, and if so, require recompilation.
  • Source incompatible: When recompiled using the new SDK or component or to target the new runtime, existing source code might require source changes to compile successfully.
  • Behavioral change: Existing binaries might behave differently at run time.

Reason for change

API review.

Recommended action

Use the new overload.

Affected APIs

No response
@DamianEdwards DamianEdwards added doc-idea Indicates issues that are suggestions for new topics [org][type][category] Pri1 High priority, do before Pri2 and Pri3 ⛓️‍💥 breaking-change Issues or PRs tracking breaking changes. labels Mar 24, 2025
@dotnetrepoman dotnetrepoman bot added the ⌚ Not Triaged Not triaged label Mar 24, 2025
@DamianEdwards DamianEdwards mentioned this issue Mar 24, 2025
Merged
8 tasks
@IEvangelist IEvangelist added this to the 9.2 milestone Mar 25, 2025
@IEvangelist IEvangelist added area-docs and removed ⌚ Not Triaged Not triaged labels Mar 25, 2025
@dotnetrepoman dotnetrepoman bot added 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. and removed 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. labels Mar 25, 2025
IEvangelist added a commit to IEvangelist/docs-aspire that referenced this issue Mar 25, 2025
@IEvangelist
Added breaking changes for 9.2, fixes dotnet#2888 and fixes dotnet#2889
025dfc8
This was referenced Mar 25, 2025
Merged
Draft
@IEvangelist IEvangelist moved this from 🔖 Ready to 👀 In review in dotnet/docs March 2025 sprint project Mar 30, 2025
@dotnetrepoman dotnetrepoman bot added the 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. label Mar 30, 2025
IEvangelist added a commit to IEvangelist/docs-aspire that referenced this issue Apr 2, 2025
@IEvangelist
Added breaking changes for 9.2, fixes dotnet#2888 and fixes dotnet#2889
f730d8f
IEvangelist added a commit that referenced this issue Apr 3, 2025
@IEvangelist
Breaking changes for .NET Aspire 9.2 (#2892)
857447a 
* Added breaking changes for 9.2, fixes #2888 and fixes #2889

* Correct TOC

* Add clarifying type name

* Fixes #2899

* Added new breaking changes docs

* Remove link

* Correct MD lint error/warnings
IEvangelist added a commit to IEvangelist/docs-aspire that referenced this issue Apr 3, 2025
@IEvangelist
Breaking changes for .NET Aspire 9.2 (dotnet#2892)
badd130 
* Added breaking changes for 9.2, fixes dotnet#2888 and fixes dotnet#2889

* Correct TOC

* Add clarifying type name

* Fixes dotnet#2899

* Added new breaking changes docs

* Remove link

* Correct MD lint error/warnings
@adegeo adegeo removed the 🗺️ mapQUEST Only used as a way to mark an issue as updated. RepoMan should instantly remove it. label Apr 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@IEvangelist IEvangelist

Labels
area-docs ⛓️‍💥 breaking-change Issues or PRs tracking breaking changes. doc-idea Indicates issues that are suggestions for new topics [org][type][category] in-pr Pri1 High priority, do before Pri2 and Pri3
Projects
dotnet/docs March 2025 sprint project
Status: 👀 In review
Milestone
9.2
Development

Successfully merging a pull request may close this issue.

.NET Aspire content for 9.2 dotnet/docs-aspire
3 participants
@DamianEdwards @IEvangelist @adegeo