Files
opentf/website/source/docs/providers/github/r/team_repository.html.markdown
Martin Atkins e914db2385 website: github_team_repository purpose clarification
With the addition of github_repository it may be confusing that
github_team_repository only creates relationships, rather than creating
actual repositories. To reduce the chance of confusion, we'll make this
explicit in the docs for github_team_repository.

Also taking this opportunity to make the examples consistent with what
would be produced by hclfmt.
2016-10-13 08:04:18 -07:00

1.3 KiB

layout, page_title, sidebar_current, description
layout page_title sidebar_current description
github GitHub: github_team_repository docs-github-resource-team-repository Manages the associations between teams and repositories.

github_team_repository

This resource manages relationships between teams and repositories in your Github organization.

Creating this resource grants a particular team permissions on a particular repository.

The repository and the team must both belong to the same organization on Github. This resource does not actually create any repositories; to do that, see github_repository.

Example Usage

# Add a repository to the team
resource "github_team" "some_team" {
  name        = "SomeTeam"
  description = "Some cool team"
}

resource "github_repository" "some_repo" {
  name = "some-repo"
}

resource "github_team_repository" "some_team_repo" {
  team_id    = "${github_team.some_team.id}"
  repository = "${github_repository.some_repo.name}"
  permission = "pull"
}

Argument Reference

The following arguments are supported:

  • team_id - (Required) The GitHub team id
  • repository - (Required) The repository to add to the team.
  • permission - (Optional) The permissions of team members regarding the repository. Must be one of pull, push, or admin. Defaults to pull.