github.project.sync

Synchronize GitHub Projects V2 project configuration.

Overview

Property	Value
Workflow type	Dag
Library	App-github
Version	1.0

Input Schema

Field	Type	Required	Default	Description
workflow_run_id	string	No	—	Parent DAG run ID
organization_uuid	string	No	—	Organization UUID
actor	string	No	—	Actor initiating the workflow
dry_run	boolean	No	—	Plan without mutating GitHub
github_connection_uuid	string	No	—	GitHub connection UUID
github_token	string	No	—	Runtime GitHub token
owner	string	No	—	GitHub organization or user login
owner_type	string	No	—	ORGANIZATION or USER
project_number	integer	No	—	GitHub project number
project_node_ref	string	No	—	GitHub ProjectV2 node ref
title	string	No	—	Project title
repository	string	No	—	Repository owner/name
repository_node_ref	string	No	—	Repository node ref
desired_repositories	list	No	—	Desired repository links
field_node_ref	string	No	—	Project field node ref
field_name	string	No	—	Project field name
field_type	string	No	—	Project field type
options	list	No	—	Single-select options
iteration_configuration	dict	No	—	Iteration config
item_node_ref	string	No	—	Project item node ref
content_node_ref	string	No	—	Issue or PR node ref
draft_issue	dict	No	—	Draft issue input
field_values	dict	No	—	Field values to apply
archive_reason	string	No	—	Archive reason
desired_access	list	No	—	Desired user/team grants
username	string	No	—	GitHub username
user_node_ref	string	No	—	GitHub user node ref
team_slug	string	No	—	GitHub team slug
team_node_ref	string	No	—	GitHub team node ref
permission	string	No	—	Project permission
view_node_ref	string	No	—	Project view node ref
view_name	string	No	—	Project view name
layout	string	No	—	View layout
filters	dict	No	—	View filters
grouping	dict	No	—	View grouping
sorting	dict	No	—	View sorting
automation_rules	list	No	—	Automation rules
workflow_rules	list	No	—	Project workflow rules
auto_add_rules	list	No	—	Auto-add rules
auto_archive_rules	list	No	—	Auto-archive rules
delivery_ref	string	No	—	Webhook delivery ID
event_type	string	No	—	Webhook event type
action	string	No	—	Webhook action
payload	dict	No	—	Webhook payload
dependency_context	dict	No	—	Prior step output

Output Schema

Field	Type	Required	Default	Description
workflow_run_id	string	No	—	Parent DAG run ID
organization_uuid	string	No	—	Organization UUID
actor	string	No	—	Actor initiating the workflow
dry_run	boolean	No	—	Plan without mutating GitHub
github_connection_uuid	string	No	—	GitHub connection UUID
github_token	string	No	—	Runtime GitHub token
owner	string	No	—	GitHub organization or user login
owner_type	string	No	—	ORGANIZATION or USER
project_number	integer	No	—	GitHub project number
project_node_ref	string	No	—	GitHub ProjectV2 node ref
title	string	No	—	Project title
repository	string	No	—	Repository owner/name
repository_node_ref	string	No	—	Repository node ref
desired_repositories	list	No	—	Desired repository links
field_node_ref	string	No	—	Project field node ref
field_name	string	No	—	Project field name
field_type	string	No	—	Project field type
options	list	No	—	Single-select options
iteration_configuration	dict	No	—	Iteration config
item_node_ref	string	No	—	Project item node ref
content_node_ref	string	No	—	Issue or PR node ref
draft_issue	dict	No	—	Draft issue input
field_values	dict	No	—	Field values to apply
archive_reason	string	No	—	Archive reason
desired_access	list	No	—	Desired user/team grants
username	string	No	—	GitHub username
user_node_ref	string	No	—	GitHub user node ref
team_slug	string	No	—	GitHub team slug
team_node_ref	string	No	—	GitHub team node ref
permission	string	No	—	Project permission
view_node_ref	string	No	—	Project view node ref
view_name	string	No	—	Project view name
layout	string	No	—	View layout
filters	dict	No	—	View filters
grouping	dict	No	—	View grouping
sorting	dict	No	—	View sorting
automation_rules	list	No	—	Automation rules
workflow_rules	list	No	—	Project workflow rules
auto_add_rules	list	No	—	Auto-add rules
auto_archive_rules	list	No	—	Auto-archive rules
delivery_ref	string	No	—	Webhook delivery ID
event_type	string	No	—	Webhook event type
action	string	No	—	Webhook action
payload	dict	No	—	Webhook payload
dependency_context	dict	No	—	Prior step output
workflow_run_uuid	string	No	—	Parent DAG run ID
upsert_project	dict	No	—	Output of the upsert_project step
sync_repositories	dict	No	—	Output of the sync_repositories step
sync_access	dict	No	—	Output of the sync_access step
status	string	No	—	Terminal status
summary	dict	No	—	Workflow summary
plan	dict	No	—	Provider operation plan
resource_refs	dict	No	—	GitHub resource references
warnings	list	No	—	Non-fatal warnings
applied	boolean	No	—	Whether provider changes were applied
provider_result	dict	No	—	Provider response
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	—	—
failed_at	string	No	—	—

DAG Layers

#	Layer	Steps	Compensation
1	upsert_project	github.project.upsert	—
2	sync_repositories	github.project-repository.sync	—
3	sync_access	github.project-access.sync	—

Execution Flow

Sub-workflows

Sub-workflow	Step name
github.project.upsert	upsert_project
github.project-repository.sync	sync_repositories
github.project-access.sync	sync_access

Business Errors

Code	Message Template
GITHUB_PROJECT_V2_INPUT_ERROR	Invalid GitHub Projects V2 workflow input

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "github.project.sync",
  "initial_data": {
    "workflow_run_id": "value",
    "organization_uuid": "value",
    "actor": "value",
    "dry_run": true
  }
}