Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/frontend/config/sidebar/docs.topics.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,10 @@ export const docsTopics: StarlightSidebarTopicsUserConfig = {
label: "What's new",
collapsed: true,
items: [
{
label: 'Aspire 17.0',
slug: 'whats-new/aspire-17-0',
},
{
label: 'Aspire 13.6',
slug: 'whats-new/aspire-13-6',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,22 +82,18 @@ For C# apps, the recommended approach is the Aspire MongoDB client integration.

### Install the client integration

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.

- **`Aspire.MongoDB.Driver`** — depends on `MongoDB.Driver` 2.x. Install this for projects using the MongoDB .NET driver version 2.
- **`Aspire.MongoDB.Driver.v3`** — depends on `MongoDB.Driver` 3.x. Install this for projects using the MongoDB .NET driver version 3.

:::danger
In a future version of Aspire, the `Aspire.MongoDB.Driver` package will be updated to reference `MongoDB.Driver` 3.x and `Aspire.MongoDB.Driver.v3` will be deprecated. For more information, see [Upgrade to version 3.0](https://www.mongodb.com/docs/drivers/csharp/v3.0/upgrade/v3/).
:::

Install the package that matches your `MongoDB.Driver` version:
Install the [📦 Aspire.MongoDB.Driver](https://www.nuget.org/packages/Aspire.MongoDB.Driver) NuGet package in the client-consuming project:

<InstallDotNetPackage packageName="Aspire.MongoDB.Driver" />

or

<InstallDotNetPackage packageName="Aspire.MongoDB.Driver.v3" />
The `Aspire.MongoDB.Driver` package references `MongoDB.Driver` version 3.x, which
introduced a binary breaking change from the 2.x line. Earlier versions of Aspire
shipped a version-suffixed `Aspire.MongoDB.Driver.v2` package to support the older
`MongoDB.Driver` 2.x line during the transition; that package has since been
removed, so all projects should reference `Aspire.MongoDB.Driver` directly. If you
still depend on `MongoDB.Driver` 2.x APIs, see [Upgrade to version
3.0](https://www.mongodb.com/docs/drivers/csharp/v3.0/upgrade/v3/) for migration
guidance.

### Add the MongoDB client

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Adding MongoDB through Aspire — rather than wiring up containers and connectio
- **Consistent connection info across languages.** Once you reference the database from a consuming app, Aspire injects connection properties as environment variables in a predictable format that works from C#, TypeScript, Python, Go, or any other language.
- **Built-in health checks.** The hosting integration automatically registers a health check so the dashboard and your orchestrator can tell when the server is ready.
- **Dashboard observability.** The database resource shows up in the Aspire dashboard with logs, status, and telemetry alongside your other services.
- **A first-class C# client integration.** C# apps can use the `Aspire.MongoDB.Driver` (or `Aspire.MongoDB.Driver.v3`) package for dependency injection, health checks, and OpenTelemetry, all wired up from the same resource name.
- **A first-class C# client integration.** C# apps can use the `Aspire.MongoDB.Driver` package for dependency injection, health checks, and OpenTelemetry, all wired up from the same resource name.
- **MongoDB Express.** Optionally spin up the [Mongo Express](https://github.com/mongo-express/mongo-express) web admin UI alongside your database with a single API call.

## How the pieces fit together
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,15 +86,10 @@ Install the [📦 Aspire.RabbitMQ.Client](https://www.nuget.org/packages/Aspire.

<InstallDotNetPackage packageName="Aspire.RabbitMQ.Client" />

<Aside type="note">
The `Aspire.RabbitMQ.Client` package references `RabbitMQ.Client` version
6.8.1. If your project requires `RabbitMQ.Client` version 7.x, install [📦
Aspire.RabbitMQ.Client.v7](https://www.nuget.org/packages/Aspire.RabbitMQ.Client.v7)
instead. In a future version of Aspire, `Aspire.RabbitMQ.Client` will be
updated to `7.x` and `Aspire.RabbitMQ.Client.v7` will be deprecated. For
migration guidance, see [Migrating to RabbitMQ .NET Client
7.x](https://github.com/rabbitmq/rabbitmq-dotnet-client/blob/main/v7-MIGRATION.md).
</Aside>
The `Aspire.RabbitMQ.Client` package references `RabbitMQ.Client` version 7.x. Earlier
versions of Aspire shipped a version-suffixed `Aspire.RabbitMQ.Client.v6` package to
support the older `RabbitMQ.Client` 6.x line during the transition; that package has
since been removed, so all projects should reference `Aspire.RabbitMQ.Client` directly.

### Add the RabbitMQ client

Expand Down
78 changes: 78 additions & 0 deletions src/frontend/src/content/docs/whats-new/aspire-17-0.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
title: "What's new in Aspire 17.0"
seoTitle: 'Aspire 17.0: New features, updates, and upgrade guidance'
description: 'Explore new features and improvements in Aspire 17.0, with upgrade guidance and breaking changes to review before updating your apps.'
sidebar:
label: Aspire 17.0
order: 0
tableOfContents:
minHeadingLevel: 2
maxHeadingLevel: 2
---

import { Icon, Steps } from '@astrojs/starlight/components';
import LearnMore from '@components/LearnMore.astro';

This page tracks changes for the upcoming Aspire 17.0 release.

We'd love to hear what you think. Drop by [<Icon name="discord" class='d-inline' /> Discord](https://aka.ms/aspire-discord) to chat with the team and the community, or file feedback and issues on [<Icon name="github" class='d-inline' /> GitHub](https://github.com/microsoft/aspire/issues).

## 🆙 Upgrade to Aspire 17.0

<span id="upgrade-to-aspire-17-0"></span>
<br />

:::caution
Review the [Breaking changes](#breaking-changes) before upgrading.
:::

For general purpose upgrade guidance, see [Upgrade Aspire](/whats-new/upgrade-aspire/).

Once Aspire 17.0 is available on the stable channel, use the [`aspire update` command](/reference/cli/commands/aspire-update/):

<Steps>

1. Update the Aspire CLI itself:

```bash title="Aspire CLI — Update the CLI"
aspire update --self
```

1. Update your projects from the repository root:

```bash title="Aspire CLI — Update all Aspire packages"
aspire update
```

</Steps>

<LearnMore>
For more details on installing the Aspire CLI, see [Install the
CLI](/get-started/install-cli/).
</LearnMore>

## ⚠️ Breaking changes

<span id="breaking-changes"></span>

#### Legacy RabbitMQ and MongoDB client packages removed

Starting in Aspire 17.0, new releases no longer include `Aspire.RabbitMQ.Client.v6` or `Aspire.MongoDB.Driver.v2`. Previously published versions of these packages remain available on NuGet.

If your app references either legacy package, replace it with the corresponding current integration:

| Removed package | Replacement package | Client library version |
| --------------------------- | ------------------------ | ---------------------- |
| `Aspire.RabbitMQ.Client.v6` | `Aspire.RabbitMQ.Client` | `RabbitMQ.Client` 7.x |
| `Aspire.MongoDB.Driver.v2` | `Aspire.MongoDB.Driver` | `MongoDB.Driver` 3.x |

Update any direct client-library package references and migrate code that uses the older driver APIs. Follow the [RabbitMQ .NET Client 7.x migration guide](https://github.com/rabbitmq/rabbitmq-dotnet-client/blob/main/v7-MIGRATION.md) and the [MongoDB .NET/C# Driver 3.0 upgrade guide](https://www.mongodb.com/docs/drivers/csharp/v3.0/upgrade/v3/).

The service registration calls, `AddRabbitMQClient` and `AddMongoDBClient`, remain the same. This removal doesn't change the behavior of the current `Aspire.RabbitMQ.Client` and `Aspire.MongoDB.Driver` packages or the AppHost hosting integrations.

<LearnMore>
See [Connect to RabbitMQ](/integrations/messaging/rabbitmq/rabbitmq-connect/)
and [Connect to MongoDB](/integrations/databases/mongodb/mongodb-connect/) for
current client setup guidance. For the removal details, see
[microsoft/aspire#20608](https://github.com/microsoft/aspire/pull/20608).
</LearnMore>
Loading