workflow_run_reviews

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

Overview

Name	workflow_run_reviews
Type	Resource
Id	github.actions.workflow_run_reviews

Fields

The following fields are returned by SELECT queries:

get_reviews_for_run

Response

Name	Datatype	Description
comment	string	The comment submitted with the deployment review (example: Ship it!)
environments	array	The list of environments that were approved or rejected
state	string	Whether deployment to the environment(s) was approved or rejected or pending (with comments) (approved, rejected, pending) (example: approved)
user	object	A GitHub user. (title: Simple User)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_reviews_for_run	select	owner, repo, run_id		Anyone with read access to the repository can use this endpoint. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with a private repository.

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.
run_id	integer	The unique identifier of the workflow run.

SELECT examples

get_reviews_for_run

Anyone with read access to the repository can use this endpoint.

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

SELECT
comment,
environments,
state,
user
FROM github.actions.workflow_run_reviews
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND run_id = '{{ run_id }}' -- required
;