feat: add data sources for listing GitHub App installations in an organization #2573

atilsensalduz · 2025-02-23T15:49:48Z

This PR introduces a new data source, github_app_installations, to enable listing all installed GitHub Apps within an organization. This addition enhances integration with existing resources such as github_app_installation_repository, providing better automation and management capabilities for GitHub App permissions.

What's New?
New Data Source: github_app_installations
Allows fetching all installed GitHub Apps in an organization:

data "github_organization_app_installations" "all_apps" {}

Example Use Case:
This data source can be integrated with the github_app_installation_repository resource to manage app permissions on specific repositories:

# Local value to find the correct app installation by slug
locals {
  # Find the index of the desired app by its slug
  app_index = index(
    data.github_organization_app_installations.all_apps.installations[*].slug,
    "desired-app-name"  # Replace with your actual app slug
  )
  
  # Get the app_id using the found index
  app_installation_id = data.github_organization_app_installations.all_apps.installations[local.app_index].id
}

# Link the repository to the app installation
resource "github_app_installation_repository" "some_app_repo" {
  installation_id = local.app_installation_id
  repository     = github_repository.some_repo.name
}

API Reference: https://docs.github.com/en/rest/orgs/orgs?apiVersion=2022-11-28#list-app-installations-for-an-organization

Related Issue: #2570

github-actions · 2025-12-06T02:12:34Z

👋 Hey Friends, this pull request has been automatically marked as stale because it has no recent activity. It will be closed if no further activity occurs. Please add the Status: Pinned label if you feel that this issue needs to remain open/active. Thank you for your contributions and help in keeping things tidy!

deiga

Hey 👋

Thank you for your contribution!

I've requested a few changes to make this fit into the provider even better :)

deiga · 2025-12-10T07:53:02Z

github/data_source_github_organization_app_installations.go

+	return &schema.Resource{
+		Read: dataSourceGithubOrganizationAppInstallationsRead,
+
+		Schema: map[string]*schema.Schema{
+			"installations": {
+				Type:     schema.TypeList,
+				Computed: true,
+				Elem: &schema.Resource{
+					Schema: map[string]*schema.Schema{
+						"id": {
+							Type:     schema.TypeInt,
+							Computed: true,
+						},
+						"slug": {
+							Type:     schema.TypeString,
+							Computed: true,
+						},
+						"app_id": {
+							Type:     schema.TypeInt,
+							Computed: true,
+						},
+					},
+				},
+			},
+		},
+	}
+}


issue: Could you please add Description fields to the Schema and all fields?

deiga · 2025-12-10T07:53:36Z

github/data_source_github_organization_app_installations.go

+
+func dataSourceGithubOrganizationAppInstallations() *schema.Resource {
+	return &schema.Resource{
+		Read: dataSourceGithubOrganizationAppInstallationsRead,


suggestion: Could you refactor this to use ReadContext?

deiga · 2025-12-10T07:55:33Z

github/data_source_github_organization_app_installations.go

+import (
+	"context"
+
+	"github.com/google/go-github/v66/github"


suggestion: I doubt we'll be able to land this before #2602

Maybe you could even rebase on top of that branch?

Suggested change

"github.com/google/go-github/v66/github"

"github.com/google/go-github/v77/github"

deiga · 2025-12-10T08:05:51Z

github/data_source_github_organization_app_installations.go

+						"app_id": {
+							Type:     schema.TypeInt,
+							Computed: true,
+						},


suggestion: Could you add the following fields to this:

repository_selection

permissions

events

html_url

client_id

target_id

target_type

suspended

deiga · 2026-01-15T20:20:27Z

@atilsensalduz Please rebase and go through the comments

atilsensalduz · 2026-01-15T20:43:54Z

@atilsensalduz Please rebase and go through the comments

Hey @deiga , apologies for the late reply. I somehow missed this PR. Thanks so much for the review! I’ve worked through your suggestions.

atilsensalduz · 2026-01-16T11:41:04Z

Hi @deiga , I've changed the PR according to your suggestions. Could you please take a look again when you have time? Thanks in advance.

deiga · 2026-01-16T11:42:03Z

github/data_source_github_organization_app_installations.go

+	return &schema.Resource{
+		ReadContext: dataSourceGithubOrganizationAppInstallationsRead,
+
+		Schema: map[string]*schema.Schema{


Please add a top-level Description field

deiga · 2026-01-16T11:43:10Z

github/data_source_github_organization_app_installations.go

+	client := meta.(*Owner).v3client
+
+	options := &github.ListOptions{
+		PerPage: 100,


Lets use the global constant here

Suggested change

PerPage: 100,

PerPage: maxPerPage,

deiga · 2026-01-16T11:52:26Z

github/data_source_github_organization_app_installations.go

+			if v := appInstallation.Permissions.Actions; v != nil {
+				permissions["actions"] = *v
+			}
+			if v := appInstallation.Permissions.Administration; v != nil {
+				permissions["administration"] = *v
+			}
+			if v := appInstallation.Permissions.Checks; v != nil {
+				permissions["checks"] = *v
+			}
+			if v := appInstallation.Permissions.Contents; v != nil {
+				permissions["contents"] = *v
+			}
+			if v := appInstallation.Permissions.Deployments; v != nil {
+				permissions["deployments"] = *v
+			}
+			if v := appInstallation.Permissions.Environments; v != nil {
+				permissions["environments"] = *v
+			}
+			if v := appInstallation.Permissions.Issues; v != nil {
+				permissions["issues"] = *v
+			}
+			if v := appInstallation.Permissions.Metadata; v != nil {
+				permissions["metadata"] = *v
+			}
+			if v := appInstallation.Permissions.Members; v != nil {
+				permissions["members"] = *v
+			}
+			if v := appInstallation.Permissions.OrganizationAdministration; v != nil {
+				permissions["organization_administration"] = *v
+			}
+			if v := appInstallation.Permissions.OrganizationHooks; v != nil {
+				permissions["organization_hooks"] = *v
+			}
+			if v := appInstallation.Permissions.OrganizationPlan; v != nil {
+				permissions["organization_plan"] = *v
+			}
+			if v := appInstallation.Permissions.OrganizationProjects; v != nil {
+				permissions["organization_projects"] = *v
+			}
+			if v := appInstallation.Permissions.OrganizationSecrets; v != nil {
+				permissions["organization_secrets"] = *v
+			}
+			if v := appInstallation.Permissions.OrganizationSelfHostedRunners; v != nil {
+				permissions["organization_self_hosted_runners"] = *v
+			}
+			if v := appInstallation.Permissions.OrganizationUserBlocking; v != nil {
+				permissions["organization_user_blocking"] = *v
+			}
+			if v := appInstallation.Permissions.Packages; v != nil {
+				permissions["packages"] = *v
+			}
+			if v := appInstallation.Permissions.Pages; v != nil {
+				permissions["pages"] = *v
+			}
+			if v := appInstallation.Permissions.PullRequests; v != nil {
+				permissions["pull_requests"] = *v
+			}
+			if v := appInstallation.Permissions.RepositoryHooks; v != nil {
+				permissions["repository_hooks"] = *v
+			}
+			if v := appInstallation.Permissions.RepositoryProjects; v != nil {
+				permissions["repository_projects"] = *v
+			}
+			if v := appInstallation.Permissions.RepositoryPreReceiveHooks; v != nil {
+				permissions["repository_pre_receive_hooks"] = *v
+			}
+			if v := appInstallation.Permissions.Secrets; v != nil {
+				permissions["secrets"] = *v
+			}
+			if v := appInstallation.Permissions.SecretScanningAlerts; v != nil {
+				permissions["secret_scanning_alerts"] = *v
+			}
+			if v := appInstallation.Permissions.SecurityEvents; v != nil {
+				permissions["security_events"] = *v
+			}
+			if v := appInstallation.Permissions.SingleFile; v != nil {
+				permissions["single_file"] = *v
+			}
+			if v := appInstallation.Permissions.Statuses; v != nil {
+				permissions["statuses"] = *v
+			}
+			if v := appInstallation.Permissions.TeamDiscussions; v != nil {
+				permissions["team_discussions"] = *v
+			}
+			if v := appInstallation.Permissions.VulnerabilityAlerts; v != nil {
+				permissions["vulnerability_alerts"] = *v
+			}
+			if v := appInstallation.Permissions.Workflows; v != nil {
+				permissions["workflows"] = *v
+			}


Could you use the Get*() accessors for these attributes to not have to deal with pointers?

And since there are so many fields, I wonder if using reflect to build a field iterator could make sense 🤔

deiga · 2026-01-16T11:53:03Z

github/data_source_github_organization_app_installations_test.go

+		check := resource.ComposeAggregateTestCheckFunc(
+			resource.TestCheckResourceAttrSet("data.github_organization_app_installations.test", "installations.0.id"),
+			resource.TestCheckResourceAttrSet("data.github_organization_app_installations.test", "installations.0.slug"),
+			resource.TestCheckResourceAttrSet("data.github_organization_app_installations.test", "installations.0.app_id"),
+		)


Please inline this variable

deiga · 2026-01-16T11:54:13Z

github/data_source_github_organization_app_installations_test.go

+		testCase := func(t *testing.T, mode string) {
+			resource.Test(t, resource.TestCase{
+				Providers: testAccProviders,
+				Steps: []resource.TestStep{
+					{
+						Config: config,
+						Check:  check,
+					},
+				},
+			})
+		}
+
+		t.Run("with an anonymous account", func(t *testing.T) {
+			t.Skip("anonymous account not supported for this operation")
+		})
+
+		t.Run("with an individual account", func(t *testing.T) {
+			t.Skip("individual account not supported for this operation")
+		})
+
+		t.Run("with an organization account", func(t *testing.T) {
+			testCase(t, organization)
+		})


We don't use this testCase pattern anymore

Suggested change

testCase := func(t *testing.T, mode string) {

resource.Test(t, resource.TestCase{

Providers: testAccProviders,

Steps: []resource.TestStep{

{

Config: config,

Check: check,

},

},

})

}

t.Run("with an anonymous account", func(t *testing.T) {

t.Skip("anonymous account not supported for this operation")

})

t.Run("with an individual account", func(t *testing.T) {

t.Skip("individual account not supported for this operation")

})

t.Run("with an organization account", func(t *testing.T) {

testCase(t, organization)

})

resource.Test(t, resource.TestCase{

PreCheck: func() { skipUnlessHasOrgs(t) },

ProviderFactories: providerFactories,

Steps: []resource.TestStep{

{

Config: config,

Check: check,

},

},

})

stevehipwell · 2026-01-30T13:13:25Z

@atilsensalduz could you please rebase this PR?

…nization

stevehipwell

Thanks for the PR @atilsensalduz, I've added a couple of comments. Could you also add support for single_file_paths, created_at & updated_at.

stevehipwell · 2026-01-30T14:52:33Z

github/data_source_github_organization_app_installations.go

+							Computed:    true,
+							Description: "The ID of the GitHub App installation.",
+						},
+						"slug": {


Should this be app_slug?

yes you're right @stevehipwell app_slug is more explicit and consistent.

github/data_source_github_organization_app_installations.go

…pp_installations data source Signed-off-by: atilsensalduz <atil.sensalduz@gmail.com>

Co-authored-by: Steve Hipwell <steve.hipwell@gmail.com>

…pp_installations data source Signed-off-by: atilsensalduz <atil.sensalduz@gmail.com>

atilsensalduz changed the title ~~feat: Add data sources for listing GitHub App installations in an organization~~ feat: add data sources for listing GitHub App installations in an organization Feb 23, 2025

nickfloyd moved this from 🆕 Triage to 👀 In review in 🧰 Octokit Active Feb 27, 2025

github-actions bot added the Status: Stale Used by stalebot to clean house label Dec 6, 2025

deiga suggested changes Dec 10, 2025

View reviewed changes

github-project-automation bot moved this from 👀 In review to 🏗 In progress in 🧰 Octokit Active Dec 10, 2025

atilsensalduz requested a review from deiga January 16, 2026 11:41

deiga suggested changes Jan 16, 2026

View reviewed changes

atilsensalduz requested a review from deiga January 16, 2026 13:37

deiga approved these changes Jan 16, 2026

View reviewed changes

stevehipwell added this to the v6.11.0 Release milestone Jan 16, 2026

stevehipwell added Type: Feature New feature or request New data source and removed Status: Stale Used by stalebot to clean house labels Jan 16, 2026

diofeher previously approved these changes Jan 16, 2026

View reviewed changes

atilsensalduz dismissed diofeher’s stale review via 354c281 January 17, 2026 11:25

deiga requested a review from stevehipwell January 29, 2026 23:16

atilsensalduz force-pushed the main branch from be4ed16 to e627a5e Compare January 30, 2026 13:25

feat: Add data source for listing GitHub App installations in an orga…

932e047

…nization

atilsensalduz force-pushed the main branch from e627a5e to 932e047 Compare January 30, 2026 14:30

stevehipwell requested changes Jan 30, 2026

View reviewed changes

atilsensalduz and others added 5 commits January 30, 2026 22:56

feat: Add additional fields and descriptions to github_organization_a…

10ac022

…pp_installations data source Signed-off-by: atilsensalduz <atil.sensalduz@gmail.com>

Update github/data_source_github_organization_app_installations.go

1d66cb3

Co-authored-by: Steve Hipwell <steve.hipwell@gmail.com>

Update github/data_source_github_organization_app_installations.go

9fcfa9a

Co-authored-by: Steve Hipwell <steve.hipwell@gmail.com>

Update github/data_source_github_organization_app_installations.go

51b195c

Co-authored-by: Steve Hipwell <steve.hipwell@gmail.com>

feat: Add additional fields and descriptions to github_organization_a…

9f5f291

…pp_installations data source Signed-off-by: atilsensalduz <atil.sensalduz@gmail.com>

	"github.com/google/go-github/v66/github"
	"github.com/google/go-github/v77/github"

feat: add data sources for listing GitHub App installations in an organization #2573

Are you sure you want to change the base?

feat: add data sources for listing GitHub App installations in an organization #2573

Uh oh!

Conversation

atilsensalduz commented Feb 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 6, 2025

Uh oh!

deiga 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!

deiga commented Jan 15, 2026

Uh oh!

atilsensalduz commented Jan 15, 2026

Uh oh!

atilsensalduz commented Jan 16, 2026

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!

stevehipwell commented Jan 30, 2026

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!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

atilsensalduz commented Feb 23, 2025 •

edited

Loading