Appearance
github.pulls.list_reviews ​
Read a GitHub pull request's reviews and report whether it is approved on an exact head.
Read a GitHub pull request's reviews and decide approval the way GitHub does: latest review per author, on the exact head.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Organization UUID |
actor | string | No | — | Actor initiating the workflow |
workflow_run_id | string | No | — | Parent workflow run id |
github_connection_uuid | uuid | No | — | GitHub installation connection UUID |
repository | string | Yes | — | Repository owner/name |
pull_number | integer | Yes | — | Pull request number |
commit_sha | string | No | — | Only reviews submitted against this exact head commit count; others are ignored |
reviewer_login | string | No | — | Only reviews by this GitHub login count toward the decision |
verdict_marker | string | No | — | Name of the HTML-comment marker a COMMENT review may carry to express a verdict, as in <!-- orkestia-verdict: SAFE -->. SAFE counts as APPROVED; FIXABLE and UNSAFE count as CHANGES_REQUESTED. Defaults to orkestia-verdict |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | — | read or failed |
repository | string | No | — | — |
pull_number | integer | No | — | — |
commit_sha | string | No | — | — |
reviews | list | No | — | Reviews considered, newest last: state, effective_state, verdict, commit_id, author_login, submitted_at, html_url, node_id |
verdict_marker | string | No | — | Marker name the decision honoured |
review_count | integer | No | — | — |
approved | boolean | No | — | No author's latest review is CHANGES_REQUESTED and at least one is APPROVED |
changes_requested | boolean | No | — | Some author's latest review is CHANGES_REQUESTED |
latest_state | string | No | — | Effective state of the most recent decision review considered, or none |
deciding_review | json | No | — | The review whose effective state produced latest_state, or null when there is no decision |
warnings | list | No | — | — |
failure_reason | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
failed_at_state | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.pulls.list_reviews",
"initial_data": {
"organization_uuid": "value",
"repository": "value",
"pull_number": 123
}
}