From 0720068923949c5f92fa24031baa710dc7726b2c Mon Sep 17 00:00:00 2001 From: David Pine Date: Wed, 19 Feb 2025 12:23:41 -0600 Subject: [PATCH 1/2] Add details about client integrations with version-suffix. Fixes #2360 --- docs/database/mongodb-integration.md | 5 ++++- docs/messaging/rabbitmq-integration.md | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/database/mongodb-integration.md b/docs/database/mongodb-integration.md index bf3097138c..944b68ef5d 100644 --- a/docs/database/mongodb-integration.md +++ b/docs/database/mongodb-integration.md @@ -1,7 +1,7 @@ --- title: .NET Aspire MongoDB database integration description: Learn how to use the .NET Aspire MongoDB database integration, which includes both hosting and client integrations. -ms.date: 12/03/2024 +ms.date: 02/19/2025 uid: database/mongodb-integration --- @@ -221,6 +221,9 @@ dotnet add package Aspire.MongoDB.Driver --- +> [!IMPORTANT] +> The `Aspire.MongoDB.Driver` NuGet package depends on the `MongoDB.Driver` NuGet package. With the release of version 3.0.0 of `MongoDB.Driver`, a binary breaking change was introduced. To address this, a new client integration package, `Aspire.MongoDB.Driver.v3`, was created. The original `Aspire.MongoDB.Driver` package continues to reference `MongoDB.Driver` version 2.30.0, ensuring compatibility with previous versions of the RabbitMQ client integration. The new `Aspire.MongoDB.Driver.v3` package references `MongoDB.Driver` version 3.0.0. + ### Add MongoDB client In the _:::no-loc text="Program.cs":::_ file of your client-consuming project, call the extension method on any to register a `IMongoClient` for use via the dependency injection container. The method takes a connection name parameter. diff --git a/docs/messaging/rabbitmq-integration.md b/docs/messaging/rabbitmq-integration.md index fdb7d23071..93795ffe0d 100644 --- a/docs/messaging/rabbitmq-integration.md +++ b/docs/messaging/rabbitmq-integration.md @@ -1,7 +1,7 @@ --- title: .NET Aspire RabbitMQ integration description: Learn how to use the .NET Aspire RabbitMQ message-broker integration, which includes both hosting and client integrations. -ms.date: 10/11/2024 +ms.date: 02/19/2025 uid: messaging/rabbitmq-integration --- @@ -165,6 +165,9 @@ dotnet add package Aspire.RabbitMQ.Client --- +> [!IMPORTANT] +> The `Aspire.RabbitMQ.Client` NuGet package depends on the `RabbitMQ.Client` NuGet package. With the release of version 7.0.0 of `RabbitMQ.Client`, a binary breaking change was introduced. To address this, a new client integration package, `Aspire.RabbitMQ.Client.v7`, was created. The original `Aspire.RabbitMQ.Client` package continues to reference `RabbitMQ.Client` version 6.8.1, ensuring compatibility with previous versions of the RabbitMQ client integration. The new `Aspire.RabbitMQ.Client.v7` package references `RabbitMQ.Client` version 7.0.0. + ### Add RabbitMQ client In the _:::no-loc text="Program.cs":::_ file of your client-consuming project, call the extension method on any to register an `IConnection` for use via the dependency injection container. The method takes a connection name parameter. From 6813e72f903df502900654fc7d0d4f3d9889bd05 Mon Sep 17 00:00:00 2001 From: David Pine Date: Wed, 19 Feb 2025 14:27:22 -0600 Subject: [PATCH 2/2] Feedback --- docs/database/mongodb-integration.md | 2 +- docs/messaging/rabbitmq-integration.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/database/mongodb-integration.md b/docs/database/mongodb-integration.md index 944b68ef5d..4e28bd81e7 100644 --- a/docs/database/mongodb-integration.md +++ b/docs/database/mongodb-integration.md @@ -222,7 +222,7 @@ dotnet add package Aspire.MongoDB.Driver --- > [!IMPORTANT] -> The `Aspire.MongoDB.Driver` NuGet package depends on the `MongoDB.Driver` NuGet package. With the release of version 3.0.0 of `MongoDB.Driver`, a binary breaking change was introduced. To address this, a new client integration package, `Aspire.MongoDB.Driver.v3`, was created. The original `Aspire.MongoDB.Driver` package continues to reference `MongoDB.Driver` version 2.30.0, ensuring compatibility with previous versions of the RabbitMQ client integration. The new `Aspire.MongoDB.Driver.v3` package references `MongoDB.Driver` version 3.0.0. +> The `Aspire.MongoDB.Driver` NuGet package depends on the `MongoDB.Driver` NuGet package. With the release of version 3.0.0 of `MongoDB.Driver`, a binary breaking change was introduced. To address this, a new client integration package, `Aspire.MongoDB.Driver.v3`, was created. The original `Aspire.MongoDB.Driver` package continues to reference `MongoDB.Driver` version 2.30.0, ensuring compatibility with previous versions of the RabbitMQ client integration. The new `Aspire.MongoDB.Driver.v3` package references `MongoDB.Driver` version 3.0.0. In a future version of .NET Aspire, the `Aspire.MongoDB.Driver` will be updated to version `3.x` and the `Aspire.MongoDB.Driver.v3` package will be deprecated. For more information, see [Upgrade to version 3.0](https://www.mongodb.com/docs/drivers/csharp/v3.0/upgrade/v3/). ### Add MongoDB client diff --git a/docs/messaging/rabbitmq-integration.md b/docs/messaging/rabbitmq-integration.md index 93795ffe0d..e32c282d34 100644 --- a/docs/messaging/rabbitmq-integration.md +++ b/docs/messaging/rabbitmq-integration.md @@ -166,7 +166,7 @@ dotnet add package Aspire.RabbitMQ.Client --- > [!IMPORTANT] -> The `Aspire.RabbitMQ.Client` NuGet package depends on the `RabbitMQ.Client` NuGet package. With the release of version 7.0.0 of `RabbitMQ.Client`, a binary breaking change was introduced. To address this, a new client integration package, `Aspire.RabbitMQ.Client.v7`, was created. The original `Aspire.RabbitMQ.Client` package continues to reference `RabbitMQ.Client` version 6.8.1, ensuring compatibility with previous versions of the RabbitMQ client integration. The new `Aspire.RabbitMQ.Client.v7` package references `RabbitMQ.Client` version 7.0.0. +> The `Aspire.RabbitMQ.Client` NuGet package depends on the `RabbitMQ.Client` NuGet package. With the release of version 7.0.0 of `RabbitMQ.Client`, a binary breaking change was introduced. To address this, a new client integration package, `Aspire.RabbitMQ.Client.v7`, was created. The original `Aspire.RabbitMQ.Client` package continues to reference `RabbitMQ.Client` version 6.8.1, ensuring compatibility with previous versions of the RabbitMQ client integration. The new `Aspire.RabbitMQ.Client.v7` package references `RabbitMQ.Client` version 7.0.0. In a future version of .NET Aspire, the `Aspire.RabbitMQ.Client` will be updated to version `7.x` and the `Aspire.RabbitMQ.Client.v7` package will be deprecated. For more information, see [Migrating to RabbitMQ .NET Client 7.x](https://github.com/rabbitmq/rabbitmq-dotnet-client/blob/main/v7-MIGRATION.md). ### Add RabbitMQ client