Remove publisher APIs

docs/compatibility/9.3/index.md

@@ -2,7 +2,7 @@
 title: Breaking changes in .NET Aspire 9.3
 titleSuffix: ""
 description: Navigate to the breaking changes in .NET Aspire 9.3.
-ms.date: 05/07/2025
+ms.date: 05/12/2025
 ---
 
 # Breaking changes in .NET Aspire 9.3
@@ -18,5 +18,6 @@ If you're migrating an app to .NET Aspire 9.3, the breaking changes listed here
 
 | Title | Type of change | Introduced version |
 |--|--|--|
-| [With health checks changes in .NET Aspire 9.3](with-health-checks-changes.md) | Binary and source incompatible | 9.3 |
 | [Change the default SKU used for creating a new Azure SQL database](azure-sql-server-default-sku-changes.md) | Behavioral change | 9.3 |
+| [Remove publisher APIs](remove-publisher-apis.md) | Binary incompatible, source incompatible, and behavioral change | 9.3 |
+| [With health checks changes in .NET Aspire 9.3](with-health-checks-changes.md) | Binary and source incompatible | 9.3 |

docs/compatibility/9.3/remove-publisher-apis.md

@@ -0,0 +1,92 @@
+---
+title: "Breaking change - Removal of DockerComposePublisher, KubernetesPublisher, and AzurePublisher"
+description: "Learn about the breaking change in .NET Aspire 9.3 where publisher APIs were removed in favor of new resource types."
+ms.date: 5/12/2025
+ai-usage: ai-assisted
+ms.custom: https://github.com/dotnet/docs-aspire/issues/3373
+---
+
+# Removal of DockerComposePublisher, KubernetesPublisher, and AzurePublisher
+
+In .NET Aspire 9.3, the `AddDockerComposePublisher`, `AddKubernetesPublisher`, and `AddAzurePublisher` APIs were removed. These APIs are now replaced with new resource types that provide a more streamlined and flexible publishing experience.
+
+## Version introduced
+
+.NET Aspire 9.3
+
+## Previous behavior
+
+In .NET Aspire 9.2, the publisher API was introduced in preview, allowing the use of the following publishers:
+
+- DockerCompose
+- Kubernetes
+- Azure
+
+These publishers were added using the following methods:
+
+- <xref:Aspire.Hosting.DockerComposePublisherExtensions.AddDockerComposePublisher*>
+- <xref:Aspire.Hosting.KubernetesPublisherExtensions.AddKubernetesPublisher*>
+- <xref:Aspire.Hosting.AzurePublisherExtensions.AddAzurePublisher*>
+
+Multiple publishers could be added, and the `aspire publish` CLI command allowed users to select one for publishing.
+
+## New behavior
+
+In .NET Aspire 9.3, the publishers are now replaced with new resource types:
+
+<!-- TODO: Add xrefs when available. -->
+
+- `DockerEnvironmentResource`
+- `KubernetesEnvironmentResource`
+- `AzureEnvironmentResource`
+
+These resources include a `PublisherCallbackAnnotation` that defines their publishing behavior. The default publisher now automatically processes all resources with this annotation to generate assets. The `aspire publish` command no longer requires selecting a publisher; it uses the default publisher to handle all annotated resources.
+
+Example:
+
+```csharp
+builder.AddDockerComposeEnvironment(publisher =>
+{
+    // Configure the Docker environment publisher
+});
+
+builder.AddKubernetesEnvironment(publisher =>
+{
+    // Configure the Kubernetes environment publisher
+});
+
+builder.AddAzureEnvironment(publisher =>
+{
+    // Configure the Azure environment publisher
+});
+```
+
+## Type of breaking change
+
+This is a [binary incompatible](../categories.md#binary-compatibility), [source incompatible](../categories.md#source-compatibility), and [behavioral change](../categories.md#behavioral-change).
+
+## Reason for change
+
+The change simplifies the publishing process by consolidating functionality into resource types with a unified publishing mechanism. For more information, see the [GitHub issue](https://github.com/dotnet/aspire/issues/9089).
+
+## Recommended action
+
+Update your code to use the new resource APIs:
+
+- Replace `AddDockerComposePublisher` with `AddDockerComposeEnvironment(...)`.
+- Replace `AddKubernetesPublisher` with `AddKubernetesEnvironment(...)`.
+- Replace `AddAzurePublisher` with `AddAzureEnvironment(...)` (implicit with any Azure resource).
+
+Example:
+
+```csharp
+builder.AddDockerComposeEnvironment(...);
+builder.AddKubernetesEnvironment(...);
+builder.AddAzureEnvironment(...);
+```
+
+## Affected APIs
+
+- `IDistributedApplicationBuilder.AddDockerComposePublisher`
+- `IDistributedApplicationBuilder.AddKubernetesPublisher`
+- `IDistributedApplicationBuilder.AddAzurePublisher`

docs/compatibility/toc.yml

@@ -17,6 +17,8 @@ items:
       href: 9.3/with-health-checks-changes.md
     - name: Azure SQL Server default SKU changes
       href: 9.3/azure-sql-server-default-sku-changes.md
+    - name: Removal of publisher APIs
+      href: 9.3/remove-publisher-apis.md
 - name: .NET Aspire 9.2
   expanded: false
   items: