fork_pr_workflows_private_repos_settings

Creates, updates, deletes, gets or lists a fork_pr_workflows_private_repos_settings resource.

Overview

Name	fork_pr_workflows_private_repos_settings
Type	Resource
Id	github.actions.fork_pr_workflows_private_repos_settings

Fields

The following fields are returned by SELECT queries:

get_private_repo_fork_pr_workflows_settings_repository

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_repository	select	owner, repo		Gets the settings for whether workflows from fork pull requests can run on a private repository. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
set_private_repo_fork_pr_workflows_settings_repository	replace	owner, repo, run_workflows_from_fork_pull_requests		Sets the settings for whether workflows from fork pull requests can run on a private repository. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

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
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.

SELECT examples

get_private_repo_fork_pr_workflows_settings_repository

Gets the settings for whether workflows from fork pull requests can run on a private repository.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

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.fork_pr_workflows_private_repos_settings
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
;

REPLACE examples

set_private_repo_fork_pr_workflows_settings_repository

Sets the settings for whether workflows from fork pull requests can run on a private repository.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

REPLACE github.actions.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 
owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required
AND run_workflows_from_fork_pull_requests = {{ run_workflows_from_fork_pull_requests }} --required;