github.pull_request-sync ​
Sync PR event for audit
Sync PR event (log for audit)
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
action | string | Yes | — | PR action |
github_pr_ref | integer | Yes | — | GitHub PR ID |
pr_data | dict | Yes | — | PR data |
repository_uuid | uuid | No | — | Repository UUID |
workflow_run_id | string | No | — | Parent DAG run ID |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
action_type | string | No | — | Action type |
github_pr_ref | integer | No | — | GitHub PR ID |
pr_number | integer | No | — | PR number |
pr_title | string | No | — | PR title |
pr_state | string | No | — | PR state |
is_draft | boolean | No | — | Is draft |
merged | boolean | No | — | Merged |
merge_commit_sha | string | No | — | Merge commit SHA |
head_branch | string | No | — | Head branch |
base_branch | string | No | — | Base branch |
author_login | string | No | — | Author login |
reviewers | list | No | — | Requested reviewers |
repository_uuid | uuid | No | — | Repository UUID |
synced_at | string | No | — | Synced timestamp |
workflow_run_id | string | No | — | Parent DAG run ID |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | 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.pull_request-sync",
"initial_data": {
"action": "value",
"github_pr_ref": 123,
"pr_data": "value"
}
}