Skip to content

Commit 20ca971

Browse files
Prevent read after update
1 parent be1616f commit 20ca971

2 files changed

Lines changed: 4 additions & 0 deletions

File tree

.github/skills/terraform-provider-pr-review/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,5 +84,6 @@ If no issues are found, explicitly state `No blocking findings found` and list r
8484
- Prefer matching resource/data source tests when implementation behavior changes.
8585
- When schema or state semantics change, treat as high-risk unless compatibility is clearly preserved.
8686
- Breaking changes must follow semantic versioning: attribute removal/rename or new required fields warrant a major version bump.
87+
- Create/update functions in this provider intentionally do **not** call the read function afterward. This reduces API call volume against GitHub's rate limits and avoids stale reads from eventually-consistent endpoints (see [#2892](https://github.com/integrations/terraform-provider-github/issues/2892)). Do not flag this as an issue.
8788
- Example configurations under `examples/` should be self-contained, follow standard module structure, and not include `provider` blocks inside nested modules.
8889
- Sensitive attributes (tokens, secrets, private keys) must be marked `Sensitive: true` in the schema and must not appear in log output.

.github/skills/terraform-provider-pr-review/references/review-checklist.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,15 @@
22

33
Use this checklist when reviewing PRs in `terraform-provider-github`.
44

5+
ALWAYS acknowledge you are using this checklist when reviewing a PR!
6+
57
## 1. Correctness and Behavior
68

79
- Verify CRUD/read logic correctly maps GitHub API responses to Terraform schema/state.
810
- Check for nil handling, default-value drift, and state flattening/expansion mismatches.
911
- Confirm update paths do not accidentally force replacement or wipe optional fields.
1012
- Validate retry/backoff and error classification for API failures.
13+
- **Do not flag** create/update functions that return `nil` instead of calling the read function. This provider intentionally avoids read-after-write to minimize API calls against GitHub's rate limits and to avoid stale reads from eventually-consistent endpoints (see [#2892](https://github.com/integrations/terraform-provider-github/issues/2892)).
1114

1215
## 2. Schema and State Compatibility
1316

0 commit comments

Comments
 (0)