Add the v8 README.md by martintmk · Pull Request #1548 · App-vNext/Polly

martintmk · 2023-09-04T12:07:05Z

Details on the issue fix or feature implementation

Adding README_V8.md that describes v8 API.
WIP, but opening early to get a continuous feedback

Compared to v7 README.md the new one is much leaner with more beefier sections extracted into separate documents. Some docs are still missing or incomplete, I'll address these in follow-up PRs to not make this one huge.

Contributes to #1091

Confirm the following

I started this PR by branching from the head of the default branch
I have targeted the PR to merge into the default branch
I have included unit tests for the issue/feature
I have successfully run a local build

martintmk · 2023-09-04T12:16:19Z

cc @peter-csala if you are interested, your feedback is greatly appreactiated too.

codecov · 2023-09-04T12:16:32Z

Codecov Report

Patch and project coverage have no change.

Comparison is base (90b7935) 83.92% compared to head (bee8d17) 83.92%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1548   +/-   ##
=======================================
  Coverage   83.92%   83.92%           
=======================================
  Files         279      279           
  Lines        6518     6518           
  Branches     1017     1017           
=======================================
  Hits         5470     5470           
  Misses        839      839           
  Partials      209      209

Flag	Coverage Δ
linux	`?`
macos	`83.92% <ø> (ø)`
windows	`83.92% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

README.md

docs/README.md

docs/dependency-injection.md

docs/extensiblity.md

martincostello · 2023-09-06T09:53:58Z

docs/general.md

+
+## Supported targets
+
+Polly targets .NET Standard 2.0+ ([coverage](https://docs.microsoft.com/en-us/dotnet/standard/net-standard#net-implementation-support): .NET Core 2.0+, .NET Core 3.0, and later Mono, Xamarin and UWP targets). The NuGet package also includes direct targets for .NET Framework 4.6.1 and 4.7.2.


Suggested change

Polly targets .NET Standard 2.0+ ([coverage](https://docs.microsoft.com/en-us/dotnet/standard/net-standard#net-implementation-support): .NET Core 2.0+, .NET Core 3.0, and later Mono, Xamarin and UWP targets). The NuGet package also includes direct targets for .NET Framework 4.6.1 and 4.7.2.

Polly targets .NET Standard 2.0+ ([coverage](https://docs.microsoft.com/dotnet/standard/net-standard#net-implementation-support): .NET Core 2.0+, .NET Core 3.0, and later Mono, Xamarin and UWP targets). The NuGet package also includes direct targets for .NET Framework 4.6.1 and 4.7.2.

martincostello · 2023-09-06T09:54:30Z

docs/general.md

+
+## Supported targets
+
+Polly targets .NET Standard 2.0+ ([coverage](https://docs.microsoft.com/en-us/dotnet/standard/net-standard#net-implementation-support): .NET Core 2.0+, .NET Core 3.0, and later Mono, Xamarin and UWP targets). The NuGet package also includes direct targets for .NET Framework 4.6.1 and 4.7.2.


Update the TFMs for v8?

martincostello · 2023-09-06T10:19:20Z

README_V8.md

+```
+<!-- endSnippet -->
+
+If all retries fail, a retry strategy rethrows the final exception back to the calling code.  For more depth visit [retry strategy documentation](https://github.com/App-vNext/Polly/wiki/Retry).


Suggested change

If all retries fail, a retry strategy rethrows the final exception back to the calling code. For more depth visit [retry strategy documentation](https://github.com/App-vNext/Polly/wiki/Retry).

If all retries fail, a retry strategy rethrows the final exception back to the calling code. For more details visit the [retry strategy documentation](https://github.com/App-vNext/Polly/wiki/Retry).

martincostello · 2023-09-06T10:19:33Z

README_V8.md

+```
+<!-- endSnippet -->
+
+If all retries fail, a retry strategy rethrows the final exception back to the calling code.  For more depth visit [retry strategy documentation](https://github.com/App-vNext/Polly/wiki/Retry).


Should this point to a newer stub too? Similar comments throughout this file to avoid linking to the Wiki in these new files.

Will update these in follow-up

README_V8.md

martincostello · 2023-09-06T12:06:03Z

src/Snippets/Docs/Hedging.cs

        // Add a customized hedging strategy that retries up to 3 times if the execution
-        // takes longer than 1 second or if it fails due to an exception
-        // or returns a 500 Internal Server Error.
+        // takes longer than 1 second or if it fails due to an exception  or returns an HTTP 500 Internal Server Error.


Suggested change

// takes longer than 1 second or if it fails due to an exception or returns an HTTP 500 Internal Server Error.

// takes longer than 1 second or if it fails due to an exception or returns an HTTP 500 Internal Server Error.

martintmk force-pushed the documentation-v8 branch 2 times, most recently from 5cdf5bc to 32f9cf8 Compare September 4, 2023 12:13

martintmk added the v8 Issues related to the new version 8 of the Polly library. label Sep 4, 2023

martintmk added this to the v8.0.0 milestone Sep 4, 2023

martintmk requested review from joelhulen and martincostello September 4, 2023 12:14

martincostello reviewed Sep 4, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

martintmk force-pushed the documentation-v8 branch 3 times, most recently from 0f1a346 to 729e40a Compare September 5, 2023 15:28

martintmk changed the title ~~Migrate the README to V8~~ Add the v8 README.md Sep 5, 2023

martintmk force-pushed the documentation-v8 branch 7 times, most recently from 290f228 to b9e4d86 Compare September 6, 2023 05:37

martintmk added 2 commits September 6, 2023 09:03

Prepare v8 README and docs

ca335ff

Cleanup the snippets

c269fc9

martintmk force-pushed the documentation-v8 branch from 0995e5d to c269fc9 Compare September 6, 2023 07:04

martintmk marked this pull request as ready for review September 6, 2023 07:05

martincostello reviewed Sep 6, 2023

View reviewed changes

martintmk added 5 commits September 6, 2023 13:24

PR comments

517127f

cleanup

2565b90

Cleanup

484d29b

Cleanup

9db41d4

Add missing italics

ccd8e74

martincostello approved these changes Sep 6, 2023

View reviewed changes

martintmk added 2 commits September 6, 2023 14:09

Add banner to some docs

e8333e8

Cleanup

bee8d17

martintmk enabled auto-merge (squash) September 6, 2023 12:10

martintmk merged commit 3f1b435 into main Sep 6, 2023

martintmk deleted the documentation-v8 branch September 6, 2023 12:49

dependabot bot mentioned this pull request Aug 18, 2025

Bump Polly from 7.2.3 to 8.6.2 QTNetModernization-5000-Repos/basistheory-dotnet_1#7

Closed

dependabot bot mentioned this pull request Aug 26, 2025

Bump Polly from 7.2.3 to 8.6.3 QTNetModernization-5000-Repos/basistheory-dotnet_1#11

Closed

dependabot bot mentioned this pull request Sep 2, 2025

build: Bump Polly from 7.2.3 to 8.6.3 apimatic/core-lib-csharp#132

Closed

This was referenced Sep 29, 2025

Bump Polly from 7.2.3 to 8.6.4 QTNetModernization-5000-Repos/basistheory-dotnet_1#13

Open

build: Bump Polly from 7.2.3 to 8.6.4 apimatic/core-lib-csharp#154

Closed

dependabot bot mentioned this pull request Oct 27, 2025

deps: Bump Polly from 7.2.3 to 8.6.4 rivoli-ai/andy-guard#51

Closed

dependabot bot mentioned this pull request Nov 24, 2025

deps: Bump Polly from 7.2.3 to 8.6.5 rivoli-ai/andy-guard#65

Open

This was referenced Jan 16, 2026

build: Bump Polly from 7.2.3 to 8.6.5 apimatic/core-lib-csharp#164

Open

Bump Polly from 7.2.3 to 8.6.5 AstraidLabs/Kitsub#51

Merged

dependabot bot mentioned this pull request Jan 29, 2026

Bump Polly from 7.2.4 to 8.6.5 AstraidLabs/Kitsub#72

Closed

dependabot bot mentioned this pull request Mar 5, 2026

Bump Polly from 7.2.4 to 8.6.6 AstraidLabs/Kitsub#79

Open

dependabot bot mentioned this pull request Mar 26, 2026

dependabot: Bump Polly from 7.2.2 to 8.6.6 rmandvikar/delegating-handlers#9

Merged


		## Supported targets

		Polly targets .NET Standard 2.0+ ([coverage](https://docs.microsoft.com/en-us/dotnet/standard/net-standard#net-implementation-support): .NET Core 2.0+, .NET Core 3.0, and later Mono, Xamarin and UWP targets). The NuGet package also includes direct targets for .NET Framework 4.6.1 and 4.7.2.

	If all retries fail, a retry strategy rethrows the final exception back to the calling code. For more depth visit [retry strategy documentation](https://github.com/App-vNext/Polly/wiki/Retry).
	If all retries fail, a retry strategy rethrows the final exception back to the calling code. For more details visit the [retry strategy documentation](https://github.com/App-vNext/Polly/wiki/Retry).

	// takes longer than 1 second or if it fails due to an exception or returns an HTTP 500 Internal Server Error.
	// takes longer than 1 second or if it fails due to an exception or returns an HTTP 500 Internal Server Error.

Uh oh!

Conversation

martintmk commented Sep 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details on the issue fix or feature implementation

Confirm the following

Uh oh!

martintmk commented Sep 4, 2023

Uh oh!

codecov bot commented Sep 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

martincostello Sep 6, 2023

Choose a reason for hiding this comment

Uh oh!

martincostello Sep 6, 2023

Choose a reason for hiding this comment

Uh oh!

martintmk Sep 6, 2023

Choose a reason for hiding this comment

Uh oh!

martincostello Sep 6, 2023

Choose a reason for hiding this comment

Uh oh!

martincostello Sep 6, 2023

Choose a reason for hiding this comment

Uh oh!

martintmk Sep 6, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

martincostello Sep 6, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

martintmk commented Sep 4, 2023 •

edited

Loading

codecov bot commented Sep 4, 2023 •

edited

Loading