Skip to content

Commit

Permalink
update documentation for github_team_members to recommended team id (#…
Browse files Browse the repository at this point in the history
…1991)

Co-authored-by: Keegan Campbell <me@kfcampbell.com>
  • Loading branch information
scott-doyland-burrows and kfcampbell authored Nov 7, 2023
1 parent edf5bda commit 5c28e97
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions website/docs/r/team_members.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,10 @@ resource "github_team_members" "some_team_members" {

The following arguments are supported:

* `team_id` - (Required) The GitHub team id or the GitHub team slug
* `team_id` - (Required) The team id or the team slug

~> **Note** Although the team id or team slug can be used it is recommended to use the team id. Using the team slug will cause the team members associations to the team to be destroyed and recreated if the team name is updated.

* `members` - (Required) List of team members. See [Members](#members) below for details.

### Members
Expand All @@ -72,7 +75,9 @@ The following arguments are supported:

## Import

GitHub Team Membership can be imported using the team ID `teamid` or team name, e.g.
~> **Note** Although the team id or team slug can be used it is recommended to use the team id. Using the team slug will result in terraform doing conversions between the team slug and team id. This will cause team members associations to the team to be destroyed and recreated on import.

GitHub Team Membership can be imported using the team ID team id or team slug, e.g.

```
$ terraform import github_team_members.some_team 1234567
Expand Down

0 comments on commit 5c28e97

Please sign in to comment.