Add summary-only flag to github_team data source #1379
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…mbers on calling the github_team data source. This improves performance of the data source when only summary information is needed by skipping API calls to get repositories and members. Especially important on orgs with large numbers of teams/members that require calling this data source multiple times. Add summary_only optional flag input to skip returning members and repositories Add 'results_per_page' optional int to reduce the results per page returned. Update docs to reflect change
alexlo03
reviewed
Nov 23, 2022
Note that team members and repositories are not returned if `summary_only = true`
david-bain
changed the title
kfcampbell
approved these changes
Nov 28, 2022
There was a problem hiding this comment.
Confirming that integration tests are passing for me locally. Thanks for contributing again, @david-bain!
kazaker
pushed a commit
to auto1-oss/terraform-provider-github
that referenced
this pull request
Dec 28, 2022
* Add a flag input to optionally skip returning the repositories and members on calling the github_team data source. This improves performance of the data source when only summary information is needed by skipping API calls to get repositories and members. Especially important on orgs with large numbers of teams/members that require calling this data source multiple times. Add summary_only optional flag input to skip returning members and repositories Add 'results_per_page' optional int to reduce the results per page returned. Update docs to reflect change * clarify docs Note that team members and repositories are not returned if `summary_only = true` Co-authored-by: Keegan Campbell <me@kfcampbell.com>
avidspartan1
pushed a commit
to avidspartan1/terraform-provider-github
that referenced
this pull request
Feb 5, 2024
* Add a flag input to optionally skip returning the repositories and members on calling the github_team data source. This improves performance of the data source when only summary information is needed by skipping API calls to get repositories and members. Especially important on orgs with large numbers of teams/members that require calling this data source multiple times. Add summary_only optional flag input to skip returning members and repositories Add 'results_per_page' optional int to reduce the results per page returned. Update docs to reflect change * clarify docs Note that team members and repositories are not returned if `summary_only = true` Co-authored-by: Keegan Campbell <me@kfcampbell.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a flag input to optionally skip returning the repositories and members on calling the github_team data source.
This improves performance of the data source call when only summary information is needed.
Especially important on orgs with large numbers of teams/members.
Resolves #1377
Behavior
Before the change?
Each call to github_teams would also make a call to get the team members and repositories. When there are a large number of teams that need querying, this could add additional time when only the team details were needed.
After the change?
This improves performance of the data source when only summary information is needed by skipping API calls to get repositories and members. Especially important on orgs with large numbers of teams/members that require calling this data source multiple times.
Other information
Basically a replication of #1176 but for single teams.
Additional info
Pull request checklist
Does this introduce a breaking change?
Please see our docs on breaking changes to help!
Type: Breaking changelabel)No, additional inputs are optional with defaults if not set resulting in no change to behaviour.
If
Yes, what's the impact:Pull request type
Please add the corresponding label for change this PR introduces:
Type: BugType: FeatureType: DocumentationType: Maintenance