Skip to content

Commit 5bdafad

Browse files
committed
docs: Fix default permission value for team block in repository_collaborators
The team block's permission description stated "Defaults to pull" but the implementation uses "push" (Default: "push" in schema definition). Update the documentation to match the implementation. Also remove "Must be push for personal repositories" as teams are only applicable to organization repositories.
1 parent 94f71cf commit 5bdafad

1 file changed

Lines changed: 1 addition & 2 deletions

File tree

website/docs/r/repository_collaborators.html.markdown

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,7 @@ The `team` block supports:
8282

8383
- `team_id` - (Required) The GitHub team id or the GitHub team slug.
8484
- `permission` - (Optional) The permission of the outside collaborators for the repository.
85-
Must be one of `pull`, `triage`, `push`, `maintain`, `admin` or the name of an existing [custom repository role](https://docs.github.com/en/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization) within the organisation. Defaults to `pull`.
86-
Must be `push` for personal repositories. Defaults to `push`.
85+
Must be one of `pull`, `triage`, `push`, `maintain`, `admin` or the name of an existing [custom repository role](https://docs.github.com/en/enterprise-cloud@latest/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization) within the organisation. Defaults to `push`.
8786

8887
The `ignore_team` block supports:
8988

0 commit comments

Comments
 (0)