» github_repository_collaborator
Provides a GitHub repository collaborator resource.
This resource allows you to add/remove collaborators from repositories in your organization. Collaborators can have explicit (and differing levels of) read, write, or administrator access to specific repositories in your organization, without giving the user full organization membership.
When applied, an invitation will be sent to the user to become a collaborator on a repository. When destroyed, either the invitation will be cancelled or the collaborator will be removed from the repository.
Further documentation on GitHub collaborators:
- Adding outside collaborators to repositories in your organization
- Converting an organization member to an outside collaborator
» Example Usage
# Add a collaborator to a repository
resource "github_repository_collaborator" "a_repo_collaborator" {
repository = "our-cool-repo"
username = "SomeUser"
permission = "admin"
}
» Argument Reference
The following arguments are supported:
-
repository
- (Required) The GitHub repository -
username
- (Required) The user to add to the repository as a collaborator. -
permission
- (Optional) The permission of the outside collaborator for the repository. Must be one ofpull
,push
, oradmin
. Defaults topush
.
» Attribute Reference
In addition to the above arguments, the following attributes are exported:
-
invitation_id
- ID of the invitation to be used ingithub_user_invitation_accepter
» Import
GitHub Repository Collaborators can be imported using an id made up of repository:username
, e.g.
$ terraform import github_repository_collaborator.collaborator terraform:someuser