org_fork_pr_workflows_private_repos_settings
Creates, updates, deletes, gets or lists an org_fork_pr_workflows_private_repos_settings resource.
Overview
| Name | org_fork_pr_workflows_private_repos_settings |
| Type | Resource |
| Id | github.actions.org_fork_pr_workflows_private_repos_settings |
Fields
The following fields are returned by SELECT queries:
- get_private_repo_fork_pr_workflows_settings_organization
Response
| Name | Datatype | Description |
|---|---|---|
require_approval_for_fork_pr_workflows | boolean | Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. |
run_workflows_from_fork_pull_requests | boolean | Whether workflows triggered by pull requests from forks are allowed to run on private repositories. |
send_secrets_and_variables | boolean | Whether to make secrets and variables available to workflows triggered by pull requests from forks. |
send_write_tokens_to_workflows | boolean | Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_private_repo_fork_pr_workflows_settings_organization | select | org | Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization. | |
set_private_repo_fork_pr_workflows_settings_organization | replace | org, run_workflows_from_fork_pull_requests | Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
org | string | The organization name. The name is not case sensitive. |
SELECT examples
- get_private_repo_fork_pr_workflows_settings_organization
Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization.
SELECT
require_approval_for_fork_pr_workflows,
run_workflows_from_fork_pull_requests,
send_secrets_and_variables,
send_write_tokens_to_workflows
FROM github.actions.org_fork_pr_workflows_private_repos_settings
WHERE org = '{{ org }}' -- required
;
REPLACE examples
- set_private_repo_fork_pr_workflows_settings_organization
Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization.
REPLACE github.actions.org_fork_pr_workflows_private_repos_settings
SET
run_workflows_from_fork_pull_requests = {{ run_workflows_from_fork_pull_requests }},
send_write_tokens_to_workflows = {{ send_write_tokens_to_workflows }},
send_secrets_and_variables = {{ send_secrets_and_variables }},
require_approval_for_fork_pr_workflows = {{ require_approval_for_fork_pr_workflows }}
WHERE
org = '{{ org }}' --required
AND run_workflows_from_fork_pull_requests = {{ run_workflows_from_fork_pull_requests }} --required;