docs/contributing: Initial error handling documentation #16794
Conversation
ghost
added
size/XL
| } | ||
| ``` | ||
|
|
||
| Future documentation will show how to properly retry the remote operation for a short period of time until it is successful to remove the error completely. |
There was a problem hiding this comment.
Will the "future documentation" replace the Pull Request Submission and Lifecycle document's section on using tfresource.TimedOut() with resource.Retry()?
Some initial and lift/shift documentation on how to handle errors in the Terraform AWS Provider codebase. Provides a walkthrough of the AWS Go SDK error type, Terraform Plugin SDK error types, and sections on some common error scenarios and expected handling.
Co-authored-by: Kit Ewbank <[email protected]>
Co-authored-by: Kit Ewbank <[email protected]>
bflad
force-pushed
the
d-provider-error-handling
branch
from
121db3c
to
fa07d1a
Compare
|
(rebased to remove merge conflict) |
|
This has been released in version 3.24.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading. For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template for triage. Thanks! |
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks! |
ghost
locked as resolved and limited conversation to collaborators
Community Note
Reference: #15792
Release note for CHANGELOG:
Some initial and lift/shift documentation on how to handle errors in the Terraform AWS Provider codebase. Provides a walkthrough of the AWS Go SDK error type, Terraform Plugin SDK error types, and sections on some common error scenarios and expected handling.
There will be separate section created specifically for waiters and retry logic.
Output from acceptance testing: N/A (documentation)