Skip to content

Commit 4169a9c

Browse files
authored
feat!: Change enterprise runner to also use ListRunnersOptions (#3167)
Fixes: #3166. BREAKING-CHANGE: This changes `ListOptions` to `ListRunnersOptions` in `EnterpriseService.ListRunners`.
1 parent 51bedeb commit 4169a9c

File tree

2 files changed

+9
-7
lines changed

2 files changed

+9
-7
lines changed

github/enterprise_actions_runners.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ func (s *EnterpriseService) CreateRegistrationToken(ctx context.Context, enterpr
8080
// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise
8181
//
8282
//meta:operation GET /enterprises/{enterprise}/actions/runners
83-
func (s *EnterpriseService) ListRunners(ctx context.Context, enterprise string, opts *ListOptions) (*Runners, *Response, error) {
83+
func (s *EnterpriseService) ListRunners(ctx context.Context, enterprise string, opts *ListRunnersOptions) (*Runners, *Response, error) {
8484
u := fmt.Sprintf("enterprises/%v/actions/runners", enterprise)
8585
u, err := addOptions(u, opts)
8686
if err != nil {

github/enterprise_actions_runners_test.go

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,22 +106,24 @@ func TestEnterpriseService_ListRunners(t *testing.T) {
106106

107107
mux.HandleFunc("/enterprises/e/actions/runners", func(w http.ResponseWriter, r *http.Request) {
108108
testMethod(t, r, "GET")
109-
testFormValues(t, r, values{"per_page": "2", "page": "2"})
110-
fmt.Fprint(w, `{"total_count":2,"runners":[{"id":23,"name":"MBP","os":"macos","status":"online"},{"id":24,"name":"iMac","os":"macos","status":"offline"}]}`)
109+
testFormValues(t, r, values{"name": "MBP", "per_page": "2", "page": "2"})
110+
fmt.Fprint(w, `{"total_count":1,"runners":[{"id":23,"name":"MBP","os":"macos","status":"online"}]}`)
111111
})
112112

113-
opts := &ListOptions{Page: 2, PerPage: 2}
113+
opts := &ListRunnersOptions{
114+
Name: String("MBP"),
115+
ListOptions: ListOptions{Page: 2, PerPage: 2},
116+
}
114117
ctx := context.Background()
115118
runners, _, err := client.Enterprise.ListRunners(ctx, "e", opts)
116119
if err != nil {
117120
t.Errorf("Enterprise.ListRunners returned error: %v", err)
118121
}
119122

120123
want := &Runners{
121-
TotalCount: 2,
124+
TotalCount: 1,
122125
Runners: []*Runner{
123126
{ID: Int64(23), Name: String("MBP"), OS: String("macos"), Status: String("online")},
124-
{ID: Int64(24), Name: String("iMac"), OS: String("macos"), Status: String("offline")},
125127
},
126128
}
127129
if !cmp.Equal(runners, want) {
@@ -130,7 +132,7 @@ func TestEnterpriseService_ListRunners(t *testing.T) {
130132

131133
const methodName = "ListRunners"
132134
testBadOptions(t, methodName, func() (err error) {
133-
_, _, err = client.Enterprise.ListRunners(ctx, "\n", &ListOptions{})
135+
_, _, err = client.Enterprise.ListRunners(ctx, "\n", &ListRunnersOptions{})
134136
return err
135137
})
136138

0 commit comments

Comments
 (0)