Skip to content

refactor!: Replace Edit with Update in permissions method names #3731

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 25, 2025
Merged

refactor!: Replace Edit with Update in permissions method names #3731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions example/actionpermissions/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ func main() {
fmt.Printf("Current ActionsPermissions %s\n", actionsPermissionsRepository.String())

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

actionsPermissionsRepository = &github.ActionsPermissionsRepository{Enabled: github.Ptr(true), AllowedActions: github.Ptr("all")}
_, _, err = client.Repositories.EditActionsPermissions(ctx, *owner, *name, *actionsPermissionsRepository)
_, _, err = client.Repositories.UpdateActionsPermissions(ctx, *owner, *name, *actionsPermissionsRepository)
if err != nil {
log.Fatal(err)
}
Expand Down
20 changes: 10 additions & 10 deletions github/actions_permissions_enterprise.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ func (s *ActionsService) GetActionsPermissionsInEnterprise(ctx context.Context,
return permissions, resp, nil
}

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

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

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

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

// EditSelfHostedRunnerPermissionsInEnterprise sets the self-hosted runner permissions for an enterprise.
// UpdateSelfHostedRunnerPermissionsInEnterprise sets the self-hosted runner permissions for an enterprise.
//
// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-self-hosted-runners-permissions-for-an-enterprise
//
//meta:operation PUT /enterprises/{enterprise}/actions/permissions/self-hosted-runners
func (s *ActionsService) EditSelfHostedRunnerPermissionsInEnterprise(ctx context.Context, enterprise string, permissions SelfHostRunnerPermissionsEnterprise) (*Response, error) {
func (s *ActionsService) UpdateSelfHostedRunnerPermissionsInEnterprise(ctx context.Context, enterprise string, permissions SelfHostRunnerPermissionsEnterprise) (*Response, error) {
u := fmt.Sprintf("enterprises/%v/actions/permissions/self-hosted-runners", enterprise)
req, err := s.client.NewRequest("PUT", u, permissions)
if err != nil {
Expand Down
70 changes: 35 additions & 35 deletions github/actions_permissions_enterprise_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ func TestActionsService_GetActionsPermissionsInEnterprise(t *testing.T) {
})
}

func TestActionsService_EditActionsPermissionsInEnterprise(t *testing.T) {
func TestActionsService_UpdateActionsPermissionsInEnterprise(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

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

ctx := context.Background()
ent, _, err := client.Actions.EditActionsPermissionsInEnterprise(ctx, "e", *input)
ent, _, err := client.Actions.UpdateActionsPermissionsInEnterprise(ctx, "e", *input)
if err != nil {
t.Errorf("Actions.EditActionsPermissionsInEnterprise returned error: %v", err)
t.Errorf("Actions.UpdateActionsPermissionsInEnterprise returned error: %v", err)
}

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

const methodName = "EditActionsPermissionsInEnterprise"
const methodName = "UpdateActionsPermissionsInEnterprise"
testBadOptions(t, methodName, func() (err error) {
_, _, err = client.Actions.EditActionsPermissionsInEnterprise(ctx, "\n", *input)
_, _, err = client.Actions.UpdateActionsPermissionsInEnterprise(ctx, "\n", *input)
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
got, resp, err := client.Actions.EditActionsPermissionsInEnterprise(ctx, "e", *input)
got, resp, err := client.Actions.UpdateActionsPermissionsInEnterprise(ctx, "e", *input)
if got != nil {
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
}
Expand Down Expand Up @@ -254,7 +254,7 @@ func TestActionsService_GetActionsAllowedInEnterprise(t *testing.T) {
})
}

func TestActionsService_EditActionsAllowedInEnterprise(t *testing.T) {
func TestActionsService_UpdateActionsAllowedInEnterprise(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

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

ctx := context.Background()
ent, _, err := client.Actions.EditActionsAllowedInEnterprise(ctx, "e", *input)
ent, _, err := client.Actions.UpdateActionsAllowedInEnterprise(ctx, "e", *input)
if err != nil {
t.Errorf("Actions.EditActionsAllowedInEnterprise returned error: %v", err)
t.Errorf("Actions.UpdateActionsAllowedInEnterprise returned error: %v", err)
}

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

const methodName = "EditActionsAllowedInEnterprise"
const methodName = "UpdateActionsAllowedInEnterprise"
testBadOptions(t, methodName, func() (err error) {
_, _, err = client.Actions.EditActionsAllowedInEnterprise(ctx, "\n", *input)
_, _, err = client.Actions.UpdateActionsAllowedInEnterprise(ctx, "\n", *input)
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
got, resp, err := client.Actions.EditActionsAllowedInEnterprise(ctx, "e", *input)
got, resp, err := client.Actions.UpdateActionsAllowedInEnterprise(ctx, "e", *input)
if got != nil {
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
}
Expand Down Expand Up @@ -332,7 +332,7 @@ func TestActionsService_GetDefaultWorkflowPermissionsInEnterprise(t *testing.T)
})
}

func TestActionsService_EditDefaultWorkflowPermissionsInEnterprise(t *testing.T) {
func TestActionsService_UpdateDefaultWorkflowPermissionsInEnterprise(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

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

ctx := context.Background()
ent, _, err := client.Actions.EditDefaultWorkflowPermissionsInEnterprise(ctx, "e", *input)
ent, _, err := client.Actions.UpdateDefaultWorkflowPermissionsInEnterprise(ctx, "e", *input)
if err != nil {
t.Errorf("Actions.EditDefaultWorkflowPermissionsInEnterprise returned error: %v", err)
t.Errorf("Actions.UpdateDefaultWorkflowPermissionsInEnterprise returned error: %v", err)
}

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

const methodName = "EditDefaultWorkflowPermissionsInEnterprise"
const methodName = "UpdateDefaultWorkflowPermissionsInEnterprise"
testBadOptions(t, methodName, func() (err error) {
_, _, err = client.Actions.EditDefaultWorkflowPermissionsInEnterprise(ctx, "\n", *input)
_, _, err = client.Actions.UpdateDefaultWorkflowPermissionsInEnterprise(ctx, "\n", *input)
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
got, resp, err := client.Actions.EditDefaultWorkflowPermissionsInEnterprise(ctx, "e", *input)
got, resp, err := client.Actions.UpdateDefaultWorkflowPermissionsInEnterprise(ctx, "e", *input)
if got != nil {
t.Errorf("testNewRequestAndDoFailure %v = %#v, want nil", methodName, got)
}
Expand Down Expand Up @@ -414,7 +414,7 @@ func TestActionsService_GetArtifactAndLogRetentionPeriodInEnterprise(t *testing.
})
}

func TestActionsService_EditArtifactAndLogRetentionPeriodInEnterprise(t *testing.T) {
func TestActionsService_UpdateArtifactAndLogRetentionPeriodInEnterprise(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

Expand All @@ -432,23 +432,23 @@ func TestActionsService_EditArtifactAndLogRetentionPeriodInEnterprise(t *testing
})

ctx := context.Background()
resp, err := client.Actions.EditArtifactAndLogRetentionPeriodInEnterprise(ctx, "e", *input)
resp, err := client.Actions.UpdateArtifactAndLogRetentionPeriodInEnterprise(ctx, "e", *input)
if err != nil {
t.Errorf("Actions.EditArtifactAndLogRetentionPeriodInEnterprise returned error: %v", err)
t.Errorf("Actions.UpdateArtifactAndLogRetentionPeriodInEnterprise returned error: %v", err)
}

if resp.StatusCode != http.StatusNoContent {
t.Errorf("Actions.EditArtifactAndLogRetentionPeriodInEnterprise = %d, want %d", resp.StatusCode, http.StatusNoContent)
t.Errorf("Actions.UpdateArtifactAndLogRetentionPeriodInEnterprise = %d, want %d", resp.StatusCode, http.StatusNoContent)
}

const methodName = "EditArtifactAndLogRetentionPeriodInEnterprise"
const methodName = "UpdateArtifactAndLogRetentionPeriodInEnterprise"
testBadOptions(t, methodName, func() (err error) {
_, err = client.Actions.EditArtifactAndLogRetentionPeriodInEnterprise(ctx, "\n", *input)
_, err = client.Actions.UpdateArtifactAndLogRetentionPeriodInEnterprise(ctx, "\n", *input)
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
return client.Actions.EditArtifactAndLogRetentionPeriodInEnterprise(ctx, "e", *input)
return client.Actions.UpdateArtifactAndLogRetentionPeriodInEnterprise(ctx, "e", *input)
})
}

Expand Down Expand Up @@ -486,7 +486,7 @@ func TestActionsService_GetSelfHostedRunnerPermissionsInEnterprise(t *testing.T)
})
}

func TestActionsService_EditSelfHostedRunnerPermissionsInEnterprise(t *testing.T) {
func TestActionsService_UpdateSelfHostedRunnerPermissionsInEnterprise(t *testing.T) {
t.Parallel()
client, mux, _ := setup(t)

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

ctx := context.Background()
resp, err := client.Actions.EditSelfHostedRunnerPermissionsInEnterprise(ctx, "e", *input)
resp, err := client.Actions.UpdateSelfHostedRunnerPermissionsInEnterprise(ctx, "e", *input)
if err != nil {
t.Errorf("Actions.EditSelfHostedRunnerPermissionsInEnterprise returned error: %v", err)
t.Errorf("Actions.UpdateSelfHostedRunnerPermissionsInEnterprise returned error: %v", err)
}

if resp.StatusCode != http.StatusNoContent {
t.Errorf("Actions.EditSelfHostedRunnerPermissionsInEnterprise = %d, want %d", resp.StatusCode, http.StatusNoContent)
t.Errorf("Actions.UpdateSelfHostedRunnerPermissionsInEnterprise = %d, want %d", resp.StatusCode, http.StatusNoContent)
}

const methodName = "EditSelfHostedRunnerPermissionsInEnterprise"
const methodName = "UpdateSelfHostedRunnerPermissionsInEnterprise"
testBadOptions(t, methodName, func() (err error) {
_, err = client.Actions.EditSelfHostedRunnerPermissionsInEnterprise(ctx, "\n", *input)
_, err = client.Actions.UpdateSelfHostedRunnerPermissionsInEnterprise(ctx, "\n", *input)
return err
})

testNewRequestAndDoFailure(t, methodName, client, func() (*Response, error) {
return client.Actions.EditSelfHostedRunnerPermissionsInEnterprise(ctx, "e", *input)
return client.Actions.UpdateSelfHostedRunnerPermissionsInEnterprise(ctx, "e", *input)
})
}

Expand Down
Loading
Loading