feat: Add private repo workflows permission API support #3679

zyfy29 · 2025-08-15T07:39:16Z

3rd Pull Request for #3660

Add support for the "Allowing workflows on fork pull requests in private repositories" APIs, covering 6 endpoints.

…resentation

Copilot

Pull Request Overview

This pull request adds API support for managing private repository fork PR workflow permissions across repositories, organizations, and enterprises. It implements 6 new endpoints for getting and setting workflow permissions that control how fork pull requests can run workflows on private repositories.

Adds WorkflowsPermissions struct to represent fork PR workflow settings
Implements repository-level API methods for getting and setting private repo fork PR workflow settings
Implements organization-level and enterprise-level API methods for the same functionality

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
github/actions_workflows.go	Adds `WorkflowsPermissions` struct with four boolean fields for controlling fork PR workflow behavior
github/repos_actions_permissions.go	Implements repository-level GET and PUT methods for private repo fork PR workflow settings
github/actions_permissions_orgs.go	Implements organization-level GET and PUT methods for private repo fork PR workflow settings
github/actions_permissions_enterprise.go	Implements enterprise-level GET and PUT methods for private repo fork PR workflow settings
github/repos_actions_permissions_test.go	Adds comprehensive tests for the repository-level API methods
github/actions_permissions_orgs_test.go	Adds comprehensive tests for the organization-level API methods
github/actions_permissions_enterprise_test.go	Adds comprehensive tests for the enterprise-level API methods
github/github-accessors.go	Adds getter methods for the `WorkflowsPermissions` struct fields
github/github-accessors_test.go	Adds tests for the getter methods
github/github-stringify_test.go	Adds test for the `String()` method of `WorkflowsPermissions`

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

codecov · 2025-08-15T12:44:14Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.10%. Comparing base (69dc04b) to head (a864e95).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3679      +/-   ##
==========================================
+ Coverage   91.07%   91.10%   +0.03%     
==========================================
  Files         186      186              
  Lines       16563    16625      +62     
==========================================
+ Hits        15085    15147      +62     
  Misses       1293     1293              
  Partials      185      185

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

gmlewis

Thank you, @zyfy29!
LGTM.

Awaiting second LGTM+Approval from any other contributor to this repo before merging.

@alexandear or @stevehipwell - might you have time for a code review? Thank you!

alexandear · 2025-08-15T16:00:26Z

github/actions_permissions_enterprise.go

+// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-enterprise
+//
+//meta:operation PUT /enterprises/{enterprise}/actions/permissions/fork-pr-workflows-private-repos
+func (s *ActionsService) EditPrivateRepoForkPRWorkflowSettingsInEnterprise(ctx context.Context, enterprise string, permissions WorkflowsPermissions) (*Response, error) {


According to the doc, the body parameter run_workflows_from_fork_pull_requests is required. So, we can't reuse WorkflowsPermissions here because RunWorkflowsFromForkPullRequests has a pointer type *bool.

Now I use a mixture of pointer and non-pointer fileds to address that. Thanks for your review!

alexandear · 2025-08-15T16:01:18Z

github/actions_workflows.go

+	RunWorkflowsFromForkPullRequests  *bool `json:"run_workflows_from_fork_pull_requests,omitempty"`
+	SendWriteTokensToWorkflows        *bool `json:"send_write_tokens_to_workflows,omitempty"`
+	SendSecretsAndVariables           *bool `json:"send_secrets_and_variables,omitempty"`
+	RequireApprovalForForkPrWorkflows *bool `json:"require_approval_for_fork_pr_workflows,omitempty"`


Suggested change

RequireApprovalForForkPrWorkflows *bool `json:"require_approval_for_fork_pr_workflows,omitempty"`

RequireApprovalForForkPRWorkflows *bool `json:"require_approval_for_fork_pr_workflows,omitempty"`

stevehipwell

CC @gmlewis

stevehipwell · 2025-08-18T09:45:03Z

github/actions_permissions_enterprise.go

+// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-enterprise
+//
+//meta:operation PUT /enterprises/{enterprise}/actions/permissions/fork-pr-workflows-private-repos
+func (s *ActionsService) EditPrivateRepoForkPRWorkflowSettingsInEnterprise(ctx context.Context, enterprise string, permissions *WorkflowsPermissionsOpt) (*Response, error) {


Suggested change

func (s *ActionsService) EditPrivateRepoForkPRWorkflowSettingsInEnterprise(ctx context.Context, enterprise string, permissions *WorkflowsPermissionsOpt) (*Response, error) {

func (s *ActionsService) UpdatePrivateRepoForkPRWorkflowSettingsInEnterprise(ctx context.Context, enterprise string, permissions *WorkflowsPermissionsOpt) (*Response, error) {

I think update makes more sense than edit both here and in the wider context of the package API.

I think you are right, @stevehipwell, thank you.

That's OK, I'll rename it.

Or may I open another pr to do that? For the permissons APIs above, methods have been named GetXXX and EditXXX where both GET and PUT methods are used for the same path. I think we better rename it all at once to keep consistency.

I'm fine either way.

OK, I renamed the methods implemented in this pr for now.

stevehipwell

LGTM

alexandear · 2025-08-19T10:50:09Z

github/actions_permissions_orgs_test.go

+	})
+}
+
+func TestActionsService_EditPrivateRepoForkPRWorkflowSettingsInOrganization(t *testing.T) {


Suggested change

func TestActionsService_EditPrivateRepoForkPRWorkflowSettingsInOrganization(t *testing.T) {

func TestActionsService_UpdatePrivateRepoForkPRWorkflowSettingsInOrganization(t *testing.T) {

Oh, I fix it. Thank you!

alexandear · 2025-08-19T10:50:33Z

github/actions_permissions_enterprise_test.go

+	})
+}
+
+func TestActionsService_EditPrivateRepoForkPRWorkflowSettingsInEnterprise(t *testing.T) {


Suggested change

func TestActionsService_EditPrivateRepoForkPRWorkflowSettingsInEnterprise(t *testing.T) {

func TestActionsService_UpdatePrivateRepoForkPRWorkflowSettingsInEnterprise(t *testing.T) {

zyfy29 added 5 commits August 15, 2025 16:16

feat: private repo pr work flow apis for enterprises

155da37

feat: private repo pr work flow apis for organization

8ec23fb

feat: private repo pr work flow apis for private repositories

7e85478

feat: Add String method to WorkflowsPermissions for better string rep…

053462c

…resentation

fix: replace WorkflowsPermissions fields to pointer type

a864e95

Copilot AI review requested due to automatic review settings August 15, 2025 07:39

Copilot AI reviewed Aug 15, 2025

View reviewed changes

gmlewis added the NeedsReview PR is awaiting a review before merging. label Aug 15, 2025

gmlewis approved these changes Aug 15, 2025

View reviewed changes

alexandear suggested changes Aug 15, 2025

View reviewed changes

zyfy29 added 2 commits August 16, 2025 07:12

fix: standardize RequireApprovalForForkPRWorkflows naming in permissions

af079dc

fix: add WorkflowsPermissionsOpt to handle required field

9e8e913

zyfy29 requested a review from alexandear August 15, 2025 22:31

stevehipwell suggested changes Aug 18, 2025

View reviewed changes

chore: rename method name 'Edit' to 'Update'

0c11edd

zyfy29 requested a review from stevehipwell August 19, 2025 05:10

stevehipwell approved these changes Aug 19, 2025

View reviewed changes

alexandear reviewed Aug 19, 2025

View reviewed changes

fix: rename test methods from 'Edit' to 'Update' for consistency

c4d4fea

zyfy29 mentioned this pull request Aug 19, 2025

Add support for new actions APIs #3660

Open

zyfy29 requested a review from alexandear August 19, 2025 12:56

	RequireApprovalForForkPrWorkflows *bool `json:"require_approval_for_fork_pr_workflows,omitempty"`
	RequireApprovalForForkPRWorkflows *bool `json:"require_approval_for_fork_pr_workflows,omitempty"`

	func (s ActionsService) EditPrivateRepoForkPRWorkflowSettingsInEnterprise(ctx context.Context, enterprise string, permissions WorkflowsPermissionsOpt) (*Response, error) {
	func (s ActionsService) UpdatePrivateRepoForkPRWorkflowSettingsInEnterprise(ctx context.Context, enterprise string, permissions WorkflowsPermissionsOpt) (*Response, error) {

	func TestActionsService_EditPrivateRepoForkPRWorkflowSettingsInOrganization(t *testing.T) {
	func TestActionsService_UpdatePrivateRepoForkPRWorkflowSettingsInOrganization(t *testing.T) {

feat: Add private repo workflows permission API support #3679

Are you sure you want to change the base?

feat: Add private repo workflows permission API support #3679

Uh oh!

Conversation

zyfy29 commented Aug 15, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

codecov bot commented Aug 15, 2025

Codecov Report

Uh oh!

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

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!

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

Uh oh!