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]: IDistributedApplicationTestingBuilder API change #2616

Open
1 of 3 tasks
ReubenBond opened this issue Feb 12, 2025 · 0 comments · May be fixed by #2566
Open
1 of 3 tasks

[Breaking change]: IDistributedApplicationTestingBuilder API change #2616

ReubenBond opened this issue Feb 12, 2025 · 0 comments · May be fixed by #2566
Assignees
@IEvangelist
Labels
⛓️‍💥 breaking-change Issues or PRs tracking breaking changes. doc-idea Indicates issues that are suggestions for new topics [org][type][category] in-pr okr-freshness OKR: Freshness of content Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest. 📦 release-9.1 Used to track doc updates for release 9.1 of .NET Aspire.

Comments

@ReubenBond
Copy link
Member

ReubenBond commented Feb 12, 2025 •
edited by sequestor bot
Loading

Description

In Aspire 9.1, IDistributedApplicationTestingBuilder was changed to inherit from IDistributedApplicationBuilder, IAsyncDisposable, and IDisposable.

Version

Other (please put exact version in description textbox)

Previous behavior

Previously, it inherited from nothing.

New behavior

IDistributedApplicationTestingBuilder was changed to inherit from IDistributedApplicationBuilder, IAsyncDisposable, and IDisposable.

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

Methods accepting a parameter of type IDistributedApplicationBuilder now work with IDistributedApplicationTestingBuilder, giving developers a consistent API surface.

Recommended action

Recompile your code if necessary. If you are implementing IDistributedApplicationTestingBuilder yourself (which would be highly unusual), then you will need to implement the new interfaces also.

Affected APIs

IDistributedApplicationTestingBuilder

Associated WorkItem - 373400
@ReubenBond ReubenBond 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 Feb 12, 2025
@dotnetrepoman dotnetrepoman bot added the ⌚ Not Triaged Not triaged label Feb 12, 2025
@ReubenBond ReubenBond mentioned this issue Feb 12, 2025
Open
@IEvangelist IEvangelist mentioned this issue Feb 13, 2025
Merged
@IEvangelist IEvangelist added 🗺️ reQUEST Triggers an issue to be imported into Quest. okr-freshness OKR: Freshness of content and removed ⌚ Not Triaged Not triaged labels Feb 13, 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 Feb 13, 2025
@IEvangelist IEvangelist moved this from 🔖 Ready to 👀 In review in dotnet/docs February 2025 sprint project Feb 13, 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 Feb 13, 2025
@IEvangelist IEvangelist linked a pull request Feb 13, 2025 that will close this issue
Open
@sequestor sequestor bot added 📌 seQUESTered Identifies that an issue has been imported into Quest. and removed 🗺️ reQUEST Triggers an issue to be imported into Quest. labels Feb 14, 2025
@IEvangelist IEvangelist added the 📦 release-9.1 Used to track doc updates for release 9.1 of .NET Aspire. label Feb 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@IEvangelist IEvangelist

Labels
⛓️‍💥 breaking-change Issues or PRs tracking breaking changes. doc-idea Indicates issues that are suggestions for new topics [org][type][category] in-pr okr-freshness OKR: Freshness of content Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest. 📦 release-9.1 Used to track doc updates for release 9.1 of .NET Aspire.
Projects
dotnet/docs February 2025 sprint project
Status: 👀 In review
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Content for .NET Aspire 9.1 dotnet/docs-aspire
2 participants
@ReubenBond @IEvangelist