From d94e59ddf76e1cc5f3e7b1b025f809a4de823a25 Mon Sep 17 00:00:00 2001 From: Eric Erhardt Date: Thu, 30 Jan 2025 10:26:44 -0600 Subject: [PATCH] Add versioning considerations to integration overview (#2425) Add a section describing how Aspire updates versions of dependencies. --- docs/fundamentals/integrations-overview.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/fundamentals/integrations-overview.md b/docs/fundamentals/integrations-overview.md index e3ebbb5b08..16dec58b44 100644 --- a/docs/fundamentals/integrations-overview.md +++ b/docs/fundamentals/integrations-overview.md @@ -56,6 +56,12 @@ When you add a client integration to a project within your .NET Aspire solution, - **[Health checks](health-checks.md)**: Exposes HTTP endpoints to provide basic availability and state information about an app. Health checks are used to influence decisions made by container orchestrators, load balancers, API gateways, and other management services. - **[Resiliency](/dotnet/core/resilience/http-resilience)**: The ability of your system to react to failure and still remain functional. Resiliency extends beyond preventing failures to include recovering and reconstructing your cloud-native environment back to a healthy state. +## Versioning considerations + +Hosting and client integrations are updated each release to target the latest stable versions of dependent resources. When container images are updated with new image versions, the hosting integrations update to these new versions. Similarly, when a new NuGet version is available for a dependent client library, the corresponding client integration updates to the new version. This ensures the latest features and security updates are available to applications. + +When major breaking changes happen in dependent resources, integrations may temporarily split into version-dependent packages to ease updating across the breaking change. For more information, see the [first example of such a breaking change](https://github.com/dotnet/aspire/issues/3956). + ## Official integrations .NET Aspire provides many integrations to help you build cloud-native applications. These integrations are designed to work seamlessly with the .NET Aspire app host and client libraries. The following sections detail cloud-agnostic, Azure-specific, Amazon Web Services (AWS), and Community Toolkit integrations.