Appearance
github.pulls.set_draft ​
Convert a GitHub pull request to draft, or mark a draft ready for review.
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 |
dry_run | boolean | No | — | Validate and plan without mutating GitHub |
github_connection_uuid | uuid | No | — | GitHub installation connection UUID |
repository | string | Yes | — | Repository owner/name |
pull_number | integer | Yes | — | Pull request number |
draft | boolean | Yes | — | True converts to draft (blocks merge); false marks ready for review |
expected_head_sha | string | No | — | Expected PR head commit SHA |
reason | string | Yes | — | Audit text recording why draft state was changed |
policy_receipt | json | No | — | Deterministic approval-gate receipt from the caller |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | — | planned, converted, already_in_state, or failed |
repository | string | No | — | — |
pull_number | integer | No | — | — |
draft | boolean | No | — | — |
is_draft | boolean | No | — | — |
pull_request_node_ref | string | No | — | — |
html_url | string | No | — | — |
applied | boolean | No | — | — |
dry_run | boolean | No | — | — |
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.set_draft",
"initial_data": {
"organization_uuid": "value",
"repository": "value",
"pull_number": 123,
"draft": true
}
}