provide readme for HealthChecks.AzureServiceBus, describe the breakin…

…g changes and point to the new package
Xabaril · Dec 18, 2023 · 63f41c2 · 63f41c2
1 parent f0cbfdc
commit 63f41c2
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/src/HealthChecks.AzureServiceBus/HealthChecks.AzureServiceBus.csproj b/src/HealthChecks.AzureServiceBus/HealthChecks.AzureServiceBus.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
-    <PackageTags>$(PackageTags);Azure;ServiceBus;EventHub</PackageTags>
+    <PackageTags>$(PackageTags);Azure;ServiceBus</PackageTags>
     <Description>HealthChecks.AzureServiceBus is the health check package for Azure Service Bus Queues and Topics.</Description>
     <VersionPrefix>$(HealthCheckAzureServiceBus)</VersionPrefix>
   </PropertyGroup>

diff --git a/src/HealthChecks.AzureServiceBus/README.md b/src/HealthChecks.AzureServiceBus/README.md
@@ -0,0 +1,7 @@
+## Azure Service Bus Health Check
+
+This health check verifies the ability to communicate with [Azure Service Bus](https://azure.microsoft.com/services/service-bus/). 
+
+### Breaking changes
+
+In the prior releases, `AzureEventHubHealthCheck` was a part of `AspNetCore.HealthChecks.AzureServiceBus` package. It had a dependency on not just `Azure.Messaging.ServiceBus`, but also `Azure.Messaging.EventHubs`. The packages have been split to avoid bringing unnecessary dependencies. The name of the new EveHub package is [AspNetCore.HealthChecks.Azure.Messaging.EventHubs](https://www.nuget.org/packages/AspNetCore.HealthChecks.Azure.Messaging.EventHubs).