Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve documentation for github_repository #2265

Merged
merged 4 commits into from
Jun 14, 2024
Merged

improve documentation for github_repository #2265

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ca7911d
improve documentation for `github_repository`
garysassano May 16, 2024
d589d03
Merge branch 'main' into fix-docs
garysassano May 23, 2024
eb1b607
Merge branch 'main' into fix-docs
nickfloyd Jun 14, 2024
f3e2246
Merge branch 'main' into fix-docs
nickfloyd Jun 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions website/docs/r/repository.html.markdown
View file
Open in desktop
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
Loading