From 994229130b4b6e5053143f1595cddb34a40ea95c Mon Sep 17 00:00:00 2001 From: Glenn Lewis <6598971+gmlewis@users.noreply.github.com> Date: Thu, 21 May 2026 08:12:49 -0600 Subject: [PATCH] refactor!: Change app installation `Find*` methods to `Get*` Signed-off-by: Glenn Lewis <6598971+gmlewis@users.noreply.github.com> --- github/apps.go | 22 +++++++------- github/apps_test.go | 70 ++++++++++++++++++++++----------------------- 2 files changed, 46 insertions(+), 46 deletions(-) diff --git a/github/apps.go b/github/apps.go index 9176e440171..75844a29ce8 100644 --- a/github/apps.go +++ b/github/apps.go @@ -448,48 +448,48 @@ func (s *AppsService) CreateAttachment(ctx context.Context, contentReferenceID i return m, resp, nil } -// FindOrganizationInstallation finds the organization's installation information. +// GetOrganizationInstallation finds the organization's installation information. // // GitHub API docs: https://docs.github.com/rest/apps/apps?apiVersion=2022-11-28#get-an-organization-installation-for-the-authenticated-app // //meta:operation GET /orgs/{org}/installation -func (s *AppsService) FindOrganizationInstallation(ctx context.Context, org string) (*Installation, *Response, error) { +func (s *AppsService) GetOrganizationInstallation(ctx context.Context, org string) (*Installation, *Response, error) { return s.getInstallation(ctx, fmt.Sprintf("orgs/%v/installation", org)) } -// FindEnterpriseInstallation finds the enterprise's installation information. +// GetEnterpriseInstallation finds the enterprise's installation information. // // GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps?apiVersion=2022-11-28#get-an-enterprise-installation-for-the-authenticated-app // //meta:operation GET /enterprises/{enterprise}/installation -func (s *AppsService) FindEnterpriseInstallation(ctx context.Context, enterprise string) (*Installation, *Response, error) { +func (s *AppsService) GetEnterpriseInstallation(ctx context.Context, enterprise string) (*Installation, *Response, error) { return s.getInstallation(ctx, fmt.Sprintf("enterprises/%v/installation", enterprise)) } -// FindRepositoryInstallation finds the repository's installation information. +// GetRepositoryInstallation finds the repository's installation information. // // GitHub API docs: https://docs.github.com/rest/apps/apps?apiVersion=2022-11-28#get-a-repository-installation-for-the-authenticated-app // //meta:operation GET /repos/{owner}/{repo}/installation -func (s *AppsService) FindRepositoryInstallation(ctx context.Context, owner, repo string) (*Installation, *Response, error) { +func (s *AppsService) GetRepositoryInstallation(ctx context.Context, owner, repo string) (*Installation, *Response, error) { return s.getInstallation(ctx, fmt.Sprintf("repos/%v/%v/installation", owner, repo)) } -// FindRepositoryInstallationByID finds the repository's installation information. +// GetRepositoryInstallationByID finds the repository's installation information. // -// Note: FindRepositoryInstallationByID uses the undocumented GitHub API endpoint "GET /repositories/{repository_id}/installation". +// Note: GetRepositoryInstallationByID uses the undocumented GitHub API endpoint "GET /repositories/{repository_id}/installation". // //meta:operation GET /repositories/{repository_id}/installation -func (s *AppsService) FindRepositoryInstallationByID(ctx context.Context, id int64) (*Installation, *Response, error) { +func (s *AppsService) GetRepositoryInstallationByID(ctx context.Context, id int64) (*Installation, *Response, error) { return s.getInstallation(ctx, fmt.Sprintf("repositories/%v/installation", id)) } -// FindUserInstallation finds the user's installation information. +// GetUserInstallation finds the user's installation information. // // GitHub API docs: https://docs.github.com/rest/apps/apps?apiVersion=2022-11-28#get-a-user-installation-for-the-authenticated-app // //meta:operation GET /users/{username}/installation -func (s *AppsService) FindUserInstallation(ctx context.Context, user string) (*Installation, *Response, error) { +func (s *AppsService) GetUserInstallation(ctx context.Context, user string) (*Installation, *Response, error) { return s.getInstallation(ctx, fmt.Sprintf("users/%v/installation", user)) } diff --git a/github/apps_test.go b/github/apps_test.go index 5a2866d4cf4..091666f2208 100644 --- a/github/apps_test.go +++ b/github/apps_test.go @@ -569,7 +569,7 @@ func TestAppsService_CreateAttachment(t *testing.T) { }) } -func TestAppsService_FindOrganizationInstallation(t *testing.T) { +func TestAppsService_GetOrganizationInstallation(t *testing.T) { t.Parallel() client, mux, _ := setup(t) @@ -579,24 +579,24 @@ func TestAppsService_FindOrganizationInstallation(t *testing.T) { }) ctx := t.Context() - installation, _, err := client.Apps.FindOrganizationInstallation(ctx, "o") + installation, _, err := client.Apps.GetOrganizationInstallation(ctx, "o") if err != nil { - t.Errorf("Apps.FindOrganizationInstallation returned error: %v", err) + t.Errorf("Apps.GetOrganizationInstallation returned error: %v", err) } want := &Installation{ID: Ptr(int64(1)), AppID: Ptr(int64(1)), TargetID: Ptr(int64(1)), TargetType: Ptr("Organization")} if !cmp.Equal(installation, want) { - t.Errorf("Apps.FindOrganizationInstallation returned %+v, want %+v", installation, want) + t.Errorf("Apps.GetOrganizationInstallation returned %+v, want %+v", installation, want) } - const methodName = "FindOrganizationInstallation" + const methodName = "GetOrganizationInstallation" testBadOptions(t, methodName, func() (err error) { - _, _, err = client.Apps.FindOrganizationInstallation(ctx, "\n") + _, _, err = client.Apps.GetOrganizationInstallation(ctx, "\n") return err }) testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { - got, resp, err := client.Apps.FindOrganizationInstallation(ctx, "o") + got, resp, err := client.Apps.GetOrganizationInstallation(ctx, "o") if got != nil { t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got) } @@ -604,7 +604,7 @@ func TestAppsService_FindOrganizationInstallation(t *testing.T) { }) } -func TestAppsService_FindEnterpriseInstallation(t *testing.T) { +func TestAppsService_GetEnterpriseInstallation(t *testing.T) { t.Parallel() client, mux, _ := setup(t) @@ -614,24 +614,24 @@ func TestAppsService_FindEnterpriseInstallation(t *testing.T) { }) ctx := t.Context() - installation, _, err := client.Apps.FindEnterpriseInstallation(ctx, "e") + installation, _, err := client.Apps.GetEnterpriseInstallation(ctx, "e") if err != nil { - t.Errorf("Apps.FindEnterpriseInstallation returned error: %v", err) + t.Errorf("Apps.GetEnterpriseInstallation returned error: %v", err) } want := &Installation{ID: Ptr(int64(1)), AppID: Ptr(int64(1)), TargetID: Ptr(int64(1)), TargetType: Ptr("Enterprise")} if !cmp.Equal(installation, want) { - t.Errorf("Apps.FindEnterpriseInstallation returned %+v, want %+v", installation, want) + t.Errorf("Apps.GetEnterpriseInstallation returned %+v, want %+v", installation, want) } - const methodName = "FindEnterpriseInstallation" + const methodName = "GetEnterpriseInstallation" testBadOptions(t, methodName, func() (err error) { - _, _, err = client.Apps.FindEnterpriseInstallation(ctx, "\n") + _, _, err = client.Apps.GetEnterpriseInstallation(ctx, "\n") return err }) testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { - got, resp, err := client.Apps.FindEnterpriseInstallation(ctx, "e") + got, resp, err := client.Apps.GetEnterpriseInstallation(ctx, "e") if got != nil { t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got) } @@ -639,7 +639,7 @@ func TestAppsService_FindEnterpriseInstallation(t *testing.T) { }) } -func TestAppsService_FindRepositoryInstallation(t *testing.T) { +func TestAppsService_GetRepositoryInstallation(t *testing.T) { t.Parallel() client, mux, _ := setup(t) @@ -649,24 +649,24 @@ func TestAppsService_FindRepositoryInstallation(t *testing.T) { }) ctx := t.Context() - installation, _, err := client.Apps.FindRepositoryInstallation(ctx, "o", "r") + installation, _, err := client.Apps.GetRepositoryInstallation(ctx, "o", "r") if err != nil { - t.Errorf("Apps.FindRepositoryInstallation returned error: %v", err) + t.Errorf("Apps.GetRepositoryInstallation returned error: %v", err) } want := &Installation{ID: Ptr(int64(1)), AppID: Ptr(int64(1)), TargetID: Ptr(int64(1)), TargetType: Ptr("Organization")} if !cmp.Equal(installation, want) { - t.Errorf("Apps.FindRepositoryInstallation returned %+v, want %+v", installation, want) + t.Errorf("Apps.GetRepositoryInstallation returned %+v, want %+v", installation, want) } - const methodName = "FindRepositoryInstallation" + const methodName = "GetRepositoryInstallation" testBadOptions(t, methodName, func() (err error) { - _, _, err = client.Apps.FindRepositoryInstallation(ctx, "\n", "\n") + _, _, err = client.Apps.GetRepositoryInstallation(ctx, "\n", "\n") return err }) testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { - got, resp, err := client.Apps.FindRepositoryInstallation(ctx, "o", "r") + got, resp, err := client.Apps.GetRepositoryInstallation(ctx, "o", "r") if got != nil { t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got) } @@ -674,7 +674,7 @@ func TestAppsService_FindRepositoryInstallation(t *testing.T) { }) } -func TestAppsService_FindRepositoryInstallationByID(t *testing.T) { +func TestAppsService_GetRepositoryInstallationByID(t *testing.T) { t.Parallel() client, mux, _ := setup(t) @@ -684,24 +684,24 @@ func TestAppsService_FindRepositoryInstallationByID(t *testing.T) { }) ctx := t.Context() - installation, _, err := client.Apps.FindRepositoryInstallationByID(ctx, 1) + installation, _, err := client.Apps.GetRepositoryInstallationByID(ctx, 1) if err != nil { - t.Errorf("Apps.FindRepositoryInstallationByID returned error: %v", err) + t.Errorf("Apps.GetRepositoryInstallationByID returned error: %v", err) } want := &Installation{ID: Ptr(int64(1)), AppID: Ptr(int64(1)), TargetID: Ptr(int64(1)), TargetType: Ptr("Organization")} if !cmp.Equal(installation, want) { - t.Errorf("Apps.FindRepositoryInstallationByID returned %+v, want %+v", installation, want) + t.Errorf("Apps.GetRepositoryInstallationByID returned %+v, want %+v", installation, want) } - const methodName = "FindRepositoryInstallationByID" + const methodName = "GetRepositoryInstallationByID" testBadOptions(t, methodName, func() (err error) { - _, _, err = client.Apps.FindRepositoryInstallationByID(ctx, -1) + _, _, err = client.Apps.GetRepositoryInstallationByID(ctx, -1) return err }) testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { - got, resp, err := client.Apps.FindRepositoryInstallationByID(ctx, 1) + got, resp, err := client.Apps.GetRepositoryInstallationByID(ctx, 1) if got != nil { t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got) } @@ -709,7 +709,7 @@ func TestAppsService_FindRepositoryInstallationByID(t *testing.T) { }) } -func TestAppsService_FindUserInstallation(t *testing.T) { +func TestAppsService_GetUserInstallation(t *testing.T) { t.Parallel() client, mux, _ := setup(t) @@ -719,24 +719,24 @@ func TestAppsService_FindUserInstallation(t *testing.T) { }) ctx := t.Context() - installation, _, err := client.Apps.FindUserInstallation(ctx, "u") + installation, _, err := client.Apps.GetUserInstallation(ctx, "u") if err != nil { - t.Errorf("Apps.FindUserInstallation returned error: %v", err) + t.Errorf("Apps.GetUserInstallation returned error: %v", err) } want := &Installation{ID: Ptr(int64(1)), AppID: Ptr(int64(1)), TargetID: Ptr(int64(1)), TargetType: Ptr("User")} if !cmp.Equal(installation, want) { - t.Errorf("Apps.FindUserInstallation returned %+v, want %+v", installation, want) + t.Errorf("Apps.GetUserInstallation returned %+v, want %+v", installation, want) } - const methodName = "FindUserInstallation" + const methodName = "GetUserInstallation" testBadOptions(t, methodName, func() (err error) { - _, _, err = client.Apps.FindUserInstallation(ctx, "\n") + _, _, err = client.Apps.GetUserInstallation(ctx, "\n") return err }) testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) { - got, resp, err := client.Apps.FindUserInstallation(ctx, "u") + got, resp, err := client.Apps.GetUserInstallation(ctx, "u") if got != nil { t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got) }