Skip to content
This repository has been archived by the owner on Nov 13, 2023. It is now read-only.

Commit

Permalink
Add v2.0.0-v2alpha doco
Browse files Browse the repository at this point in the history
Also link to latest IHttpClientFactory documentation. Fixes #4
  • Loading branch information
reisenberger committed May 3, 2018
1 parent 0e01b70 commit ebd83bd
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 14 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## 2.0.0-v2alpha
- Publish as strong-named package only (discontinue non-strong-named versions)

## 1.0.3
- RTM version

Expand Down
2 changes: 1 addition & 1 deletion GitVersionConfig.yaml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
next-version: 1.0.3
next-version: 2.0.0
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,7 @@ Polly is a member of the [.NET Foundation](https://www.dotnetfoundation.org/abou

Install-Package Polly.Extensions.Http

You can install the Strongly Named version via:

Install-Package Polly.Extensions.Http-Signed

The strongly-named version works with the strongly-named Polly-Signed nuget package.
This package contains a strongly-named DLL.

# Convenience methods for transient faults of HttpClient calls

Expand Down Expand Up @@ -72,9 +68,9 @@ var policy = Policy
.RetryAsync(3);
```

# Using Polly.Extensions.Http with HttpClientFactory
# Using Polly.Extensions.Http with IHttpClientFactory

Polly.Extensions.Http is ideal for creating custom Polly policies for use with HttpClientFactory ([preview1 blog post](https://blogs.msdn.microsoft.com/webdev/2018/02/28/asp-net-core-2-1-preview1-introducing-httpclient-factory/); [preview2 blog post](https://blogs.msdn.microsoft.com/webdev/2018/04/12/asp-net-core-2-1-0-preview2-now-available/)), available from ASP.NET Core 2.1.
Polly.Extensions.Http is ideal for creating custom Polly policies for use with IHttpClientFactory, available from ASP.NET Core 2.1.

```csharp
var retryPolicy = HttpPolicyExtensions
Expand All @@ -89,11 +85,14 @@ serviceCollection.AddHttpClient("example.com", c => c.BaseAddress = new Uri("htt
.AddPolicyHandler(timeoutPolicy);
```

#### TODO: link to public HttpClientFactory documentation and/or expand example, when that documentation is published.
## Official documentation

# For more information on Polly
+ [Microsoft documentation on IHttpClientFactory](https://docs.microsoft.com/en-gb/aspnet/core/fundamentals/http-requests?view=aspnetcore-2.1)
+ [Microsoft documentation on using Polly policies with IHttpClientFactory](https://docs.microsoft.com/en-gb/aspnet/core/fundamentals/http-requests?view=aspnetcore-2.1#use-polly-based-handlers)
+ [Polly documentation on Polly and HttpClientFactory](https://github.com/App-vNext/Polly/wiki/Polly-and-HttpClientFactory)
+ [Main Polly readme](https://github.com/App-vNext/Polly): quickstart details of all Polly policies and features
+ [Polly wiki](https://github.com/App-vNext/Polly/wiki): deep doco on Polly features

For more information on Polly and configuring Polly policies see the [main Polly repository](https://github.com/App-vNext/Polly) and [wiki](https://github.com/App-vNext/Polly/wiki).

# Release notes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
using System.Runtime.CompilerServices;

[assembly: AssemblyTitle("Polly.Extensions.Http")]
[assembly: AssemblyInformationalVersion("1.0.5.0")]
[assembly: AssemblyFileVersion("1.0.5.0")]
[assembly: AssemblyVersion("1.0.0.0")]
[assembly: AssemblyInformationalVersion("2.0.0.0")]
[assembly: AssemblyFileVersion("2.0.0.0")]
[assembly: AssemblyVersion("2.0.0.0")]
[assembly: CLSCompliant(true)]

[assembly: InternalsVisibleTo("Polly.Extensions.Http.NetStandard11.Specs")]
4 changes: 4 additions & 0 deletions src/Polly.Extensions.Http.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
<tags>HttpClient Exception Handling Resilience Transient Fault Policy</tags>
<copyright>Copyright © 2018, App vNext</copyright>
<releaseNotes>
2.0.0-v2alpha
---------------------
- Publish as strong-named package only (discontinue non-strong-named versions)

1.0.3
---------------------
- RTM version
Expand Down

0 comments on commit ebd83bd

Please sign in to comment.