Skip to content

Commit 215d1ca

Browse files
zyfy29zyfy29
authored
refactor!: Replace Edit with Update in permissions method names (#3731)
BREAKING CHANGE: Permissions-related methods are renamed from `Edit*` to `Update*`.
1 parent 30fb0c6 commit 215d1ca

12 files changed

+145
-145
lines changed

‎example/actionpermissions/main.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ func main() {
4545
fmt.Printf("Current ActionsPermissions %s\n", actionsPermissionsRepository.String())
4646

4747
actionsPermissionsRepository = &github.ActionsPermissionsRepository{Enabled: github.Ptr(true), AllowedActions: github.Ptr("selected")}
48-
_, _, err = client.Repositories.EditActionsPermissions(ctx, *owner, *name, *actionsPermissionsRepository)
48+
_, _, err = client.Repositories.UpdateActionsPermissions(ctx, *owner, *name, *actionsPermissionsRepository)
4949
if err != nil {
5050
log.Fatal(err)
5151
}
@@ -68,7 +68,7 @@ func main() {
6868
fmt.Printf("Current ActionsAllowed %s\n", actionsAllowed.String())
6969

7070
actionsPermissionsRepository = &github.ActionsPermissionsRepository{Enabled: github.Ptr(true), AllowedActions: github.Ptr("all")}
71-
_, _, err = client.Repositories.EditActionsPermissions(ctx, *owner, *name, *actionsPermissionsRepository)
71+
_, _, err = client.Repositories.UpdateActionsPermissions(ctx, *owner, *name, *actionsPermissionsRepository)
7272
if err != nil {
7373
log.Fatal(err)
7474
}

‎github/actions_permissions_enterprise.go‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@ func (s *ActionsService) GetActionsPermissionsInEnterprise(ctx context.Context,
6868
return permissions, resp, nil
6969
}
7070

71-
// EditActionsPermissionsInEnterprise sets the permissions policy in an enterprise.
71+
// UpdateActionsPermissionsInEnterprise sets the permissions policy in an enterprise.
7272
//
7373
// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise
7474
//
7575
//meta:operation PUT /enterprises/{enterprise}/actions/permissions
76-
func (s *ActionsService) EditActionsPermissionsInEnterprise(ctx context.Context, enterprise string, actionsPermissionsEnterprise ActionsPermissionsEnterprise) (*ActionsPermissionsEnterprise, *Response, error) {
76+
func (s *ActionsService) UpdateActionsPermissionsInEnterprise(ctx context.Context, enterprise string, actionsPermissionsEnterprise ActionsPermissionsEnterprise) (*ActionsPermissionsEnterprise, *Response, error) {
7777
u := fmt.Sprintf("enterprises/%v/actions/permissions", enterprise)
7878
req, err := s.client.NewRequest("PUT", u, actionsPermissionsEnterprise)
7979
if err != nil {
@@ -202,12 +202,12 @@ func (s *ActionsService) GetActionsAllowedInEnterprise(ctx context.Context, ente
202202
return actionsAllowed, resp, nil
203203
}
204204

205-
// EditActionsAllowedInEnterprise sets the actions that are allowed in an enterprise.
205+
// UpdateActionsAllowedInEnterprise sets the actions that are allowed in an enterprise.
206206
//
207207
// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise
208208
//
209209
//meta:operation PUT /enterprises/{enterprise}/actions/permissions/selected-actions
210-
func (s *ActionsService) EditActionsAllowedInEnterprise(ctx context.Context, enterprise string, actionsAllowed ActionsAllowed) (*ActionsAllowed, *Response, error) {
210+
func (s *ActionsService) UpdateActionsAllowedInEnterprise(ctx context.Context, enterprise string, actionsAllowed ActionsAllowed) (*ActionsAllowed, *Response, error) {
211211
u := fmt.Sprintf("enterprises/%v/actions/permissions/selected-actions", enterprise)
212212
req, err := s.client.NewRequest("PUT", u, actionsAllowed)
213213
if err != nil {
@@ -245,12 +245,12 @@ func (s *ActionsService) GetDefaultWorkflowPermissionsInEnterprise(ctx context.C
245245
return permissions, resp, nil
246246
}
247247

248-
// EditDefaultWorkflowPermissionsInEnterprise sets the GitHub Actions default workflow permissions for an enterprise.
248+
// UpdateDefaultWorkflowPermissionsInEnterprise sets the GitHub Actions default workflow permissions for an enterprise.
249249
//
250250
// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise
251251
//
252252
//meta:operation PUT /enterprises/{enterprise}/actions/permissions/workflow
253-
func (s *ActionsService) EditDefaultWorkflowPermissionsInEnterprise(ctx context.Context, enterprise string, permissions DefaultWorkflowPermissionEnterprise) (*DefaultWorkflowPermissionEnterprise, *Response, error) {
253+
func (s *ActionsService) UpdateDefaultWorkflowPermissionsInEnterprise(ctx context.Context, enterprise string, permissions DefaultWorkflowPermissionEnterprise) (*DefaultWorkflowPermissionEnterprise, *Response, error) {
254254
u := fmt.Sprintf("enterprises/%v/actions/permissions/workflow", enterprise)
255255
req, err := s.client.NewRequest("PUT", u, permissions)
256256
if err != nil {
@@ -288,12 +288,12 @@ func (s *ActionsService) GetArtifactAndLogRetentionPeriodInEnterprise(ctx contex
288288
return arp, resp, nil
289289
}
290290

291-
// EditArtifactAndLogRetentionPeriodInEnterprise sets the artifact and log retention period for an enterprise.
291+
// UpdateArtifactAndLogRetentionPeriodInEnterprise sets the artifact and log retention period for an enterprise.
292292
//
293293
// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-enterprise
294294
//
295295
//meta:operation PUT /enterprises/{enterprise}/actions/permissions/artifact-and-log-retention
296-
func (s *ActionsService) EditArtifactAndLogRetentionPeriodInEnterprise(ctx context.Context, enterprise string, period ArtifactPeriodOpt) (*Response, error) {
296+
func (s *ActionsService) UpdateArtifactAndLogRetentionPeriodInEnterprise(ctx context.Context, enterprise string, period ArtifactPeriodOpt) (*Response, error) {
297297
u := fmt.Sprintf("enterprises/%v/actions/permissions/artifact-and-log-retention", enterprise)
298298
req, err := s.client.NewRequest("PUT", u, period)
299299
if err != nil {
@@ -324,12 +324,12 @@ func (s *ActionsService) GetSelfHostedRunnerPermissionsInEnterprise(ctx context.
324324
return permissions, resp, nil
325325
}
326326

327-
// EditSelfHostedRunnerPermissionsInEnterprise sets the self-hosted runner permissions for an enterprise.
327+
// UpdateSelfHostedRunnerPermissionsInEnterprise sets the self-hosted runner permissions for an enterprise.
328328
//
329329
// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise
330330
//
331331
//meta:operation PUT /enterprises/{enterprise}/actions/permissions/self-hosted-runners
332-
func (s *ActionsService) EditSelfHostedRunnerPermissionsInEnterprise(ctx context.Context, enterprise string, permissions SelfHostRunnerPermissionsEnterprise) (*Response, error) {
332+
func (s *ActionsService) UpdateSelfHostedRunnerPermissionsInEnterprise(ctx context.Context, enterprise string, permissions SelfHostRunnerPermissionsEnterprise) (*Response, error) {
333333
u := fmt.Sprintf("enterprises/%v/actions/permissions/self-hosted-runners", enterprise)
334334
req, err := s.client.NewRequest("PUT", u, permissions)
335335
if err != nil {

‎github/actions_permissions_enterprise_test.go‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ func TestActionsService_GetActionsPermissionsInEnterprise(t *testing.T) {
4949
})
5050
}
5151

52-
func TestActionsService_EditActionsPermissionsInEnterprise(t *testing.T) {
52+
func TestActionsService_UpdateActionsPermissionsInEnterprise(t *testing.T) {
5353
t.Parallel()
5454
client, mux, _ := setup(t)
5555

@@ -68,24 +68,24 @@ func TestActionsService_EditActionsPermissionsInEnterprise(t *testing.T) {
6868
})
6969

7070
ctx := context.Background()
71-
ent, _, err := client.Actions.EditActionsPermissionsInEnterprise(ctx, "e", *input)
71+
ent, _, err := client.Actions.UpdateActionsPermissionsInEnterprise(ctx, "e", *input)
7272
if err != nil {
73-
t.Errorf("Actions.EditActionsPermissionsInEnterprise returned error: %v", err)
73+
t.Errorf("Actions.UpdateActionsPermissionsInEnterprise returned error: %v", err)
7474
}
7575

7676
want := &ActionsPermissionsEnterprise{EnabledOrganizations: Ptr("all"), AllowedActions: Ptr("selected")}
7777
if !cmp.Equal(ent, want) {
78-
t.Errorf("Actions.EditActionsPermissionsInEnterprise returned %+v, want %+v", ent, want)
78+
t.Errorf("Actions.UpdateActionsPermissionsInEnterprise returned %+v, want %+v", ent, want)
7979
}
8080

81-
const methodName = "EditActionsPermissionsInEnterprise"
81+
const methodName = "UpdateActionsPermissionsInEnterprise"
8282
testBadOptions(t, methodName, func() (err error) {
83-
_, _, err = client.Actions.EditActionsPermissionsInEnterprise(ctx, "\n", *input)
83+
_, _, err = client.Actions.UpdateActionsPermissionsInEnterprise(ctx, "\n", *input)
8484
return err
8585
})
8686

8787
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
88-
got, resp, err := client.Actions.EditActionsPermissionsInEnterprise(ctx, "e", *input)
88+
got, resp, err := client.Actions.UpdateActionsPermissionsInEnterprise(ctx, "e", *input)
8989
if got != nil {
9090
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
9191
}
@@ -254,7 +254,7 @@ func TestActionsService_GetActionsAllowedInEnterprise(t *testing.T) {
254254
})
255255
}
256256

257-
func TestActionsService_EditActionsAllowedInEnterprise(t *testing.T) {
257+
func TestActionsService_UpdateActionsAllowedInEnterprise(t *testing.T) {
258258
t.Parallel()
259259
client, mux, _ := setup(t)
260260

@@ -273,24 +273,24 @@ func TestActionsService_EditActionsAllowedInEnterprise(t *testing.T) {
273273
})
274274

275275
ctx := context.Background()
276-
ent, _, err := client.Actions.EditActionsAllowedInEnterprise(ctx, "e", *input)
276+
ent, _, err := client.Actions.UpdateActionsAllowedInEnterprise(ctx, "e", *input)
277277
if err != nil {
278-
t.Errorf("Actions.EditActionsAllowedInEnterprise returned error: %v", err)
278+
t.Errorf("Actions.UpdateActionsAllowedInEnterprise returned error: %v", err)
279279
}
280280

281281
want := &ActionsAllowed{GithubOwnedAllowed: Ptr(true), VerifiedAllowed: Ptr(false), PatternsAllowed: []string{"a/b"}}
282282
if !cmp.Equal(ent, want) {
283-
t.Errorf("Actions.EditActionsAllowedInEnterprise returned %+v, want %+v", ent, want)
283+
t.Errorf("Actions.UpdateActionsAllowedInEnterprise returned %+v, want %+v", ent, want)
284284
}
285285

286-
const methodName = "EditActionsAllowedInEnterprise"
286+
const methodName = "UpdateActionsAllowedInEnterprise"
287287
testBadOptions(t, methodName, func() (err error) {
288-
_, _, err = client.Actions.EditActionsAllowedInEnterprise(ctx, "\n", *input)
288+
_, _, err = client.Actions.UpdateActionsAllowedInEnterprise(ctx, "\n", *input)
289289
return err
290290
})
291291

292292
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
293-
got, resp, err := client.Actions.EditActionsAllowedInEnterprise(ctx, "e", *input)
293+
got, resp, err := client.Actions.UpdateActionsAllowedInEnterprise(ctx, "e", *input)
294294
if got != nil {
295295
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
296296
}
@@ -332,7 +332,7 @@ func TestActionsService_GetDefaultWorkflowPermissionsInEnterprise(t *testing.T)
332332
})
333333
}
334334

335-
func TestActionsService_EditDefaultWorkflowPermissionsInEnterprise(t *testing.T) {
335+
func TestActionsService_UpdateDefaultWorkflowPermissionsInEnterprise(t *testing.T) {
336336
t.Parallel()
337337
client, mux, _ := setup(t)
338338

@@ -351,24 +351,24 @@ func TestActionsService_EditDefaultWorkflowPermissionsInEnterprise(t *testing.T)
351351
})
352352

353353
ctx := context.Background()
354-
ent, _, err := client.Actions.EditDefaultWorkflowPermissionsInEnterprise(ctx, "e", *input)
354+
ent, _, err := client.Actions.UpdateDefaultWorkflowPermissionsInEnterprise(ctx, "e", *input)
355355
if err != nil {
356-
t.Errorf("Actions.EditDefaultWorkflowPermissionsInEnterprise returned error: %v", err)
356+
t.Errorf("Actions.UpdateDefaultWorkflowPermissionsInEnterprise returned error: %v", err)
357357
}
358358

359359
want := &DefaultWorkflowPermissionEnterprise{DefaultWorkflowPermissions: Ptr("read"), CanApprovePullRequestReviews: Ptr(true)}
360360
if !cmp.Equal(ent, want) {
361-
t.Errorf("Actions.EditDefaultWorkflowPermissionsInEnterprise returned %+v, want %+v", ent, want)
361+
t.Errorf("Actions.UpdateDefaultWorkflowPermissionsInEnterprise returned %+v, want %+v", ent, want)
362362
}
363363

364-
const methodName = "EditDefaultWorkflowPermissionsInEnterprise"
364+
const methodName = "UpdateDefaultWorkflowPermissionsInEnterprise"
365365
testBadOptions(t, methodName, func() (err error) {
366-
_, _, err = client.Actions.EditDefaultWorkflowPermissionsInEnterprise(ctx, "\n", *input)
366+
_, _, err = client.Actions.UpdateDefaultWorkflowPermissionsInEnterprise(ctx, "\n", *input)
367367
return err
368368
})
369369

370370
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
371-
got, resp, err := client.Actions.EditDefaultWorkflowPermissionsInEnterprise(ctx, "e", *input)
371+
got, resp, err := client.Actions.UpdateDefaultWorkflowPermissionsInEnterprise(ctx, "e", *input)
372372
if got != nil {
373373
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
374374
}
@@ -414,7 +414,7 @@ func TestActionsService_GetArtifactAndLogRetentionPeriodInEnterprise(t *testing.
414414
})
415415
}
416416

417-
func TestActionsService_EditArtifactAndLogRetentionPeriodInEnterprise(t *testing.T) {
417+
func TestActionsService_UpdateArtifactAndLogRetentionPeriodInEnterprise(t *testing.T) {
418418
t.Parallel()
419419
client, mux, _ := setup(t)
420420

@@ -432,23 +432,23 @@ func TestActionsService_EditArtifactAndLogRetentionPeriodInEnterprise(t *testing
432432
})
433433

434434
ctx := context.Background()
435-
resp, err := client.Actions.EditArtifactAndLogRetentionPeriodInEnterprise(ctx, "e", *input)
435+
resp, err := client.Actions.UpdateArtifactAndLogRetentionPeriodInEnterprise(ctx, "e", *input)
436436
if err != nil {
437-
t.Errorf("Actions.EditArtifactAndLogRetentionPeriodInEnterprise returned error: %v", err)
437+
t.Errorf("Actions.UpdateArtifactAndLogRetentionPeriodInEnterprise returned error: %v", err)
438438
}
439439

440440
if resp.StatusCode != http.StatusNoContent {
441-
t.Errorf("Actions.EditArtifactAndLogRetentionPeriodInEnterprise = %d, want %d", resp.StatusCode, http.StatusNoContent)
441+
t.Errorf("Actions.UpdateArtifactAndLogRetentionPeriodInEnterprise = %d, want %d", resp.StatusCode, http.StatusNoContent)
442442
}
443443

444-
const methodName = "EditArtifactAndLogRetentionPeriodInEnterprise"
444+
const methodName = "UpdateArtifactAndLogRetentionPeriodInEnterprise"
445445
testBadOptions(t, methodName, func() (err error) {
446-
_, err = client.Actions.EditArtifactAndLogRetentionPeriodInEnterprise(ctx, "\n", *input)
446+
_, err = client.Actions.UpdateArtifactAndLogRetentionPeriodInEnterprise(ctx, "\n", *input)
447447
return err
448448
})
449449

450450
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
451-
return client.Actions.EditArtifactAndLogRetentionPeriodInEnterprise(ctx, "e", *input)
451+
return client.Actions.UpdateArtifactAndLogRetentionPeriodInEnterprise(ctx, "e", *input)
452452
})
453453
}
454454

@@ -486,7 +486,7 @@ func TestActionsService_GetSelfHostedRunnerPermissionsInEnterprise(t *testing.T)
486486
})
487487
}
488488

489-
func TestActionsService_EditSelfHostedRunnerPermissionsInEnterprise(t *testing.T) {
489+
func TestActionsService_UpdateSelfHostedRunnerPermissionsInEnterprise(t *testing.T) {
490490
t.Parallel()
491491
client, mux, _ := setup(t)
492492

@@ -504,23 +504,23 @@ func TestActionsService_EditSelfHostedRunnerPermissionsInEnterprise(t *testing.T
504504
})
505505

506506
ctx := context.Background()
507-
resp, err := client.Actions.EditSelfHostedRunnerPermissionsInEnterprise(ctx, "e", *input)
507+
resp, err := client.Actions.UpdateSelfHostedRunnerPermissionsInEnterprise(ctx, "e", *input)
508508
if err != nil {
509-
t.Errorf("Actions.EditSelfHostedRunnerPermissionsInEnterprise returned error: %v", err)
509+
t.Errorf("Actions.UpdateSelfHostedRunnerPermissionsInEnterprise returned error: %v", err)
510510
}
511511

512512
if resp.StatusCode != http.StatusNoContent {
513-
t.Errorf("Actions.EditSelfHostedRunnerPermissionsInEnterprise = %d, want %d", resp.StatusCode, http.StatusNoContent)
513+
t.Errorf("Actions.UpdateSelfHostedRunnerPermissionsInEnterprise = %d, want %d", resp.StatusCode, http.StatusNoContent)
514514
}
515515

516-
const methodName = "EditSelfHostedRunnerPermissionsInEnterprise"
516+
const methodName = "UpdateSelfHostedRunnerPermissionsInEnterprise"
517517
testBadOptions(t, methodName, func() (err error) {
518-
_, err = client.Actions.EditSelfHostedRunnerPermissionsInEnterprise(ctx, "\n", *input)
518+
_, err = client.Actions.UpdateSelfHostedRunnerPermissionsInEnterprise(ctx, "\n", *input)
519519
return err
520520
})
521521

522522
testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
523-
return client.Actions.EditSelfHostedRunnerPermissionsInEnterprise(ctx, "e", *input)
523+
return client.Actions.UpdateSelfHostedRunnerPermissionsInEnterprise(ctx, "e", *input)
524524
})
525525
}
526526

0 commit comments

Comments
 (0)