feat: add prefix filter to team sync groups data source by laughedelic · Pull Request #3248 · integrations/terraform-provider-github

laughedelic · 2026-03-02T03:24:12Z

Resolves [FEAT]: Support filter parameter on github_organization_team_sync_groups data source #1809

Before the change?

Currently, the github_organization_team_sync_groups data source fetches all groups (in fixed page sizes of 100). This causes performance issues if a large number of groups are synced into GitHub (we have about 3000 groups being pushed to GitHub, so the refresh of github_organization_team_sync_groups takes 20+ seconds).

After the change?

Now it's possible to filter groups by prefix:

data "github_organization_team_sync_groups" "filtered" {
  prefix_filter = "myprefix_"
}

Pull request checklist

Schema migrations have been created if needed (example)
Tests for the changes have been added (for bug fixes / features)
Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

No

~~I followed the API and the SDK in naming it q, but I'm open to something more descriptive, e.g. prefix or prefix_filter~~

github-actions · 2026-03-02T03:24:23Z

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

deiga

Thanks for the PR. I left some comments that need addressing

deiga

Sorry, the ID will need to change and thus we need a schema migration

stevehipwell

@laughadelic please could you rebase this PR, please note that we've changed how the docs work and ideally want to generate the docs for this data source via the automation.

stevehipwell

Thanks for updating @laughedelic, I've added some review comments.

stevehipwell · 2026-06-29T10:26:11Z

 	}

+	if v, ok := d.GetOk("prefix_filter"); ok {
+		options.Query = v.(string)


Suggested change

options.Query = v.(string)

q, _ := v.(string)

options.Query = q

Otherwise you'll get a lint failure.

Done in de55491

stevehipwell · 2026-06-29T10:26:58Z

+	"github.com/hashicorp/terraform-plugin-testing/tfjsonpath"
 )

 func TestAccGithubOrganizationTeamSyncGroupsDataSource_existing(t *testing.T) {


Suggested change

func TestAccGithubOrganizationTeamSyncGroupsDataSource_existing(t *testing.T) {

func TestAccGithubOrganizationTeamSyncGroupsDataSource(t *testing.T) {

Please nest sub-tests using t.Run instead of using steps for separate tests. I suggest the following sub tests.

all

Single step

filtered

Step 1 a filter that matches

Step 2 change the filter to match nothing

Done in de55491

stevehipwell · 2026-06-29T10:31:15Z


 ## Example Usage

+Retrieve all IdP groups:


Please can you update the docs to use the template pattern of automatically inserting the examples and using the schema for the attribute descriptions, meaning this description should be a comment in the example file.

Done in de55491 and d2915b1

stevehipwell · 2026-06-29T10:32:31Z

 	}

-	d.SetId(fmt.Sprintf("%s/github-org-team-sync-groups", orgName))
+	id, err := buildID(orgName, options.Query)


This might be clearer if we use a placeholder when query isn't set.

Done in de55491. The ID is now <org>:* when no filter is set, and <org>:<prefix> otherwise

stevehipwell · 2026-06-29T10:33:36Z

+			"prefix_filter": {
+				Type:        schema.TypeString,
+				Optional:    true,
+				Description: "Filters the results to return only those that begin with the specified value.",


I'm assuming there are rules on the naming of team sync groups? If so we need to validate here.

I don't think there's anything to validate here. These names come from the external identity provider rather than from GitHub, so the permitted characters are whatever the IdP allows. Entra ID group names, Okta group names, etc. From my experience with Okta, there isn't any expected format.

Adds an optional prefix_filter argument to github_organization_team_sync_groups that filters returned IdP groups to those whose names begin with the given value. Uses buildID(orgName, options.Query) for the resource ID. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

- Avoid a lint failure by using a checked type assertion when reading the prefix_filter value. - Use "*" as an explicit placeholder in the data source ID when no prefix filter is set, so the ID always has the same shape. - Restructure the acceptance test into `all` and `filtered` sub-tests using t.Run instead of packing unrelated cases into steps. The `filtered` sub-test first applies a matching prefix, then switches to a prefix that matches nothing. - Switch the docs template to the standard tfplugindocs pattern: the examples are inserted automatically from the example files and the attribute documentation comes from the schema. The prose describing each example moved into the example files as comments.

The previous hand-written template was replaced with the standard tfplugindocs pattern in the previous commit, but the examples were not picked up because they lived in a directory named after the short data source name. tfplugindocs discovers them under examples/data-sources/<full_data_source_name>/data-source*.tf, so the examples move to examples/data-sources/github_organization_team_sync_groups/ and are renamed accordingly. With the description moved onto the schema, the per-data-source template no longer adds anything over templates/data-sources.md.tmpl, so it is removed and the page is now fully generated.

github-actions Bot added the Type: Feature New feature or request label Mar 2, 2026

deiga requested changes Mar 2, 2026

View reviewed changes

laughedelic requested a review from deiga March 2, 2026 22:54

laughedelic changed the title ~~feat: add query filter to team sync groups data source~~ feat: add prefix filter to team sync groups data source Mar 4, 2026

deiga requested changes Mar 4, 2026

View reviewed changes

Comment thread github/data_source_github_organization_team_sync_groups.go Outdated

Comment thread github/data_source_github_organization_team_sync_groups_test.go Outdated

laughedelic requested a review from deiga March 5, 2026 01:37

deiga reviewed Mar 5, 2026

View reviewed changes

Comment thread github/data_source_github_organization_team_sync_groups.go Outdated

laughedelic requested a review from deiga May 13, 2026 15:36

stevehipwell requested changes Jun 5, 2026

View reviewed changes

Comment thread github/data_source_github_organization_team_sync_groups.go Outdated

Comment thread github/data_source_github_organization_team_sync_groups.go Outdated

laughedelic force-pushed the feat/team-sync-groups-q branch from e21fe5d to c2041b9 Compare June 28, 2026 20:31

laughedelic requested a review from stevehipwell June 28, 2026 20:34

stevehipwell requested changes Jun 29, 2026

View reviewed changes

laughedelic and others added 4 commits August 17, 2026 02:00

Update docs to include prefix_filter argument and example

4f9be63

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

laughedelic force-pushed the feat/team-sync-groups-q branch from c2041b9 to d2915b1 Compare August 17, 2026 00:12

laughedelic requested a review from stevehipwell August 17, 2026 00:21

	options.Query = v.(string)
	q, _ := v.(string)
	options.Query = q

	func TestAccGithubOrganizationTeamSyncGroupsDataSource_existing(t *testing.T) {
	func TestAccGithubOrganizationTeamSyncGroupsDataSource(t *testing.T) {

Uh oh!

Conversation

laughedelic commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before the change?

After the change?

Pull request checklist

Does this introduce a breaking change?

Uh oh!

github-actions Bot commented Mar 2, 2026

Uh oh!

deiga left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

deiga left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

stevehipwell left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

laughedelic commented Mar 2, 2026 •

edited

Loading