Skip to content

Commit

Permalink
Add NuGet package descriptions
Browse files Browse the repository at this point in the history
- Add NuGet package description for each library.
- Add library-specific NuGet package tags.

Resolves #1812.
  • Loading branch information
martincostello committed Nov 20, 2023
1 parent d02f4ab commit 4ab0b17
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 1 deletion.
1 change: 0 additions & 1 deletion eng/Library.targets
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
<NeutralLanguage>en-US</NeutralLanguage>
<PackageLicenseExpression>BSD-3-Clause</PackageLicenseExpression>
<PackageProjectUrl>https://github.com/App-vNext/Polly</PackageProjectUrl>
<PackageTags>Exception Handling Resilience Transient Fault Policy Circuit Breaker CircuitBreaker Retry Wait Cache Cache-aside Bulkhead Rate-limit Fallback Timeout Throttle Parallelization Hedging</PackageTags>
<PackageReleaseNotes>See https://github.com/App-vNext/Polly/blob/main/CHANGELOG.md for details</PackageReleaseNotes>
<PackageReadmeFile>package-readme.md</PackageReadmeFile>
</PropertyGroup>
Expand Down
5 changes: 5 additions & 0 deletions src/Polly.Core/Polly.Core.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@
<IsTrimmable>true</IsTrimmable>
</PropertyGroup>

<PropertyGroup>
<Description>Polly.Core is a .NET resilience and transient-fault-handling library that allows developers to express resilience strategies such as Retry, Circuit Breaker, Hedging, Timeout, Chaos and Fallback in a fluent and thread-safe manner.</Description>
<PackageTags>Polly Simmy Exception Handling Resilience Transient Fault Policy Circuit Breaker CircuitBreaker Chaos ChaosEngineering Retry Wait Fallback Timeout Parallelization Hedging</PackageTags>
</PropertyGroup>

<ItemGroup>
<Using Include="Polly.Utils" />
<InternalsVisibleToProject Include="Polly.Core.Benchmarks" />
Expand Down
6 changes: 6 additions & 0 deletions src/Polly.Extensions/Polly.Extensions.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@
<IsAotCompatible>true</IsAotCompatible>
<IsTrimmable>true</IsTrimmable>
</PropertyGroup>

<PropertyGroup>
<Description>Polly.Extensions adds support for dependency injection and telemetry for the Polly.Core library.</Description>
<PackageTags>Polly Exception Handling Resilience Transient Fault Policy DI DependencyInjection IOC InversionOfControl Metrics Observability Telemetry</PackageTags>
</PropertyGroup>

<ItemGroup>
<Compile Include="..\Polly.Core\ResilienceValidationContext.cs" Link="Utils\ResilienceValidationContext.cs" />
<Compile Include="..\Polly.Core\Utils\Guard.cs" Link="Utils\Guard.cs" />
Expand Down
5 changes: 5 additions & 0 deletions src/Polly.RateLimiting/Polly.RateLimiting.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@
<IsTrimmable>true</IsTrimmable>
</PropertyGroup>

<PropertyGroup>
<Description>Polly.RateLimiting is a .NET resilience and transient-fault-handling library that allows developers to express resilience strategies using a Rate Limiter in a fluent and thread-safe manner.</Description>
<PackageTags>Polly Exception Handling Resilience Transient Fault Policy Wait Bulkhead Rate-limit Throttle Hedging</PackageTags>
</PropertyGroup>

<ItemGroup>
<Using Include="Polly.Utils" />
<Compile Include="..\Polly.Core\Utils\ExceptionUtilities.cs" Link="utils\ExceptionUtilities.cs" />
Expand Down
5 changes: 5 additions & 0 deletions src/Polly.Testing/Polly.Testing.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@
<MutationScore>100</MutationScore>
</PropertyGroup>

<PropertyGroup>
<Description>Polly.Testing exposes APIs and utilities that can be used to assert on the composition of Polly.Core resilience pipelines.</Description>
<PackageTags>Polly Exception Handling Resilience Transient Fault Policy Testing</PackageTags>
</PropertyGroup>

<ItemGroup>
<ProjectReference Include="..\Polly.Core\Polly.Core.csproj" />
</ItemGroup>
Expand Down
5 changes: 5 additions & 0 deletions src/Polly/Polly.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@
<NoWarn>$(NoWarn);RS0037;</NoWarn>
</PropertyGroup>

<PropertyGroup>
<Description>Polly is a .NET resilience and transient-fault-handling library that allows developers to express resilience and transient fault handling policies such as Retry, Circuit Breaker, Timeout, Bulkhead Isolation, and Fallback in a fluent and thread-safe manner.</Description>
<PackageTags>Polly Exception Handling Resilience Transient Fault Policy Circuit Breaker CircuitBreaker Retry Wait Cache Cache-aside Bulkhead Fallback Timeout Throttle</PackageTags>
</PropertyGroup>

<ItemGroup>
<InternalsVisibleToProject Include="Polly.Specs" />
</ItemGroup>
Expand Down

0 comments on commit 4ab0b17

Please sign in to comment.