Skip to content

Commit

Permalink
improve documentation for github_repository (#2265)
Browse files Browse the repository at this point in the history
Co-authored-by: Nick Floyd <[email protected]>
  • Loading branch information
garysassano and nickfloyd authored Jun 14, 2024
1 parent 4d638fc commit aa07277
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions website/docs/r/repository.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ description: |-
This resource allows you to create and manage repositories within your
GitHub organization or personal account.

~> Note: When used with GitHub App authentication, even GET requests must have
the `contents:write` permission or else the `allow_merge_commit`, `allow_rebase_merge`,
and `allow_squash_merge` attributes will be ignored, causing confusing diffs.
~> 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:

- `allow_merge_commit` (including the related `merge_commit_title` and `merge_commit_message`)
- `allow_squash_merge` (including the related `squash_merge_commit_title` and `squash_merge_commit_message`)
- `allow_rebase_merge`

## Example Usage

Expand Down

0 comments on commit aa07277

Please sign in to comment.