Add github_teams data source #725
Conversation
|
When I read the data source name I make a leap that I can ask for specific teams when this only looks to solve the "all" use case. I think that should be in the name of the data source if that is the scope of this source. There is a data source for a single |
|
@majormoses Good point. Maybe it would be good to discuss this in #726 ? |
This better reflects that the data source fetches all teams for an organization.
Setting the attribute to true causes the query to only return teams at the root of the organization.
|
I've changed the name of the data source to |
|
Seems on the right track from what I'm reading over in the related issue and from the code itself. Can we also get an update to |
|
Ah, somehow missed that. Fixed. |
| variables["cursor"] = githubv4.NewString(query.Organization.Teams.PageInfo.EndCursor) | ||
| } | ||
|
|
||
| d.SetId(strconv.FormatInt(time.Now().Unix(), 10)) |
There was a problem hiding this comment.
Interesting approach here. 🤔 I'm unsure if this will cause unwanted behaviour and have not seen this pattern used before. 👍🏾 on trying it but we'll need to keep an eye out for fixes that may need to occur due to choosing what seems to be a non-deterministic ID.
I see a similar data source pins to the overall org ID:
// github/data_source_github_organization.go
d.SetId(strconv.FormatInt(organization.GetID(), 10))There was a problem hiding this comment.
It is something I picked up from Hashicorp's tutorials (https://learn.hashicorp.com/tutorials/terraform/provider-setup#implement-read) and used more often but I think that it causes -refresh=false to have no effect. I've added a commit to change this.
(Btw, I was a bit surprised that the ID returned by the GraphQL API is already a string, it seems to be something different from the v3 REST API.)
There was a problem hiding this comment.
Sorry, added another change. In the previous commit I added the value of root_teams_only to the ID so it would be unique between multiple instances of the data source (edge case). But that is of course not necessary, so I simplified that again.
This makes the ID deterministic and prevents overriding the behaviour.
Adding the root_teams_only property to the ID is not needed. Two datasources having the same ID property is no problem.
* Add github_teams data source * Add id field to teams field of github_teams data source * Add website docs for github_teams data source * Fix linting errors in data_source_github_teams.go * Rename github_teams to github_organization_teams This better reflects that the data source fetches all teams for an organization. * Add root_teams_only attribute to github_organization_teams Setting the attribute to true causes the query to only return teams at the root of the organization. * Add link to github_organization_teams docs in sidebar * Use organization ID in datasource ID This makes the ID deterministic and prevents overriding the behaviour. * Simplify ID of github_organization_teams data source Adding the root_teams_only property to the ID is not needed. Two datasources having the same ID property is no problem.
The
github_teamsdata source is useful to get all teams of an organization without having prior knowledge of their names/slug.One of the use cases is to synchronize these teams and their members to some external system.
This uses the GraphQL API and returns all teams of an organization including their members in a single request per 100 teams.