Skip to content

Commit 33ca276

Browse files
committed
update README
1 parent 9d124b4 commit 33ca276

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,46 @@ Set environment variables:
4444
## Usage
4545

4646
```hcl
47+
resource "github_repository_ruleset" "example" {
48+
name = "example-ruleset"
49+
repository = "repo"
50+
target = "branch"
51+
enforcement = "active"
52+
53+
conditions {
54+
ref_name {
55+
include = ["~DEFAULT_BRANCH"]
56+
exclude = []
57+
}
58+
}
59+
60+
rules {
61+
pull_request {
62+
required_approving_review_count = 1
63+
dismiss_stale_reviews_on_push = true
64+
require_code_owner_review = true
65+
require_last_push_approval = false
66+
required_review_thread_resolution = false
67+
}
68+
}
69+
}
70+
4771
resource "kwgithub_ruleset_allowed_merge_methods" "example" {
4872
repository = "repo"
49-
ruleset_id = "123456"
73+
ruleset_id = github_repository_ruleset.example.ruleset_id
5074
allowed_merge_methods = ["merge", "squash"]
75+
76+
# Recommended: GitHub resets allowed_merge_methods when ruleset is updated
77+
force_update = timestamp()
78+
79+
depends_on = [github_repository_ruleset.example]
5180
}
5281
```
5382

83+
### ⚠️Important: Force Update Recommendation
84+
85+
It is strongly recommended to include `force_update = timestamp()` in your resource configuration. This ensures the resource is updated on every Terraform run, which is necessary because GitHub's API specification causes `allowed_merge_methods` to be reset whenever `github_repository_ruleset` is updated. Without `force_update`, your merge method configuration may be unexpectedly lost when other ruleset changes are applied.
86+
5487
## Why This Provider?
5588

5689
The official GitHub provider resets `allowed_merge_methods` when updating other ruleset rules. This provider automatically detects and restores the expected configuration.

0 commit comments

Comments
 (0)