Skip to content

Commit aa07277

Browse files
improve documentation for github_repository (#2265)
Co-authored-by: Nick Floyd <[email protected]>
1 parent 4d638fc commit aa07277

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

website/docs/r/repository.html.markdown

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ description: |-
1010
This resource allows you to create and manage repositories within your
1111
GitHub organization or personal account.
1212

13-
~> Note: When used with GitHub App authentication, even GET requests must have
14-
the `contents:write` permission or else the `allow_merge_commit`, `allow_rebase_merge`,
15-
and `allow_squash_merge` attributes will be ignored, causing confusing diffs.
13+
~> Note: When used with GitHub App authentication, even GET requests must have the `contents:write` permission. Without it, the following attributes will be ignored, leading to unexpected behavior and confusing diffs:
14+
15+
- `allow_merge_commit` (including the related `merge_commit_title` and `merge_commit_message`)
16+
- `allow_squash_merge` (including the related `squash_merge_commit_title` and `squash_merge_commit_message`)
17+
- `allow_rebase_merge`
1618

1719
## Example Usage
1820

0 commit comments

Comments
 (0)