docs(projects): document project workflow API

This commit is contained in:
Lunny Xiao committed 2026-10-22 16:24:28 -07:00
1 parent c902fe9253
commit 602612a046
3 files changed
+42

No files matched your search

@@ -84,6 +84,20 @@ description: "以事件、篩選條件與動作組合,替儲存庫專案自動
- 工作流程所做的變更在時間軸中顯示為由「專案工作流程」完成,並歸屬於觸發該事件的使用者,與 CODEOWNERS 發起的審查請求相同。這些變更不會觸發其他工作流程。
- 只有能讀取項目的使用者才能將其加入專案或移動其卡片,因此工作流程不會替使用者操作其無法查看的項目。
## API
也可以透過 REST API 管理工作流程,路徑位於儲存庫(`/repos/{owner}/{repo}/projects/{id}`)、組織(`/orgs/{org}/projects/{id}`)或目前使用者(`/user/projects/{id}`)的專案路由下:
| 方法 | 路徑 | 用途 |
| --- | --- | --- |
| `GET` | `.../workflows` | 列出專案的工作流程 |
| `GET` | `.../workflows/{workflow_id}` | 取得工作流程 |
| `POST` | `.../workflows` | 建立工作流程 |
| `PATCH` | `.../workflows/{workflow_id}` | 編輯工作流程,未提供的欄位保持不變 |
| `DELETE` | `.../workflows/{workflow_id}` | 刪除工作流程 |
工作流程包含 `event`(`item_added_to_project`、`item_removed_from_project`、`item_reopened`、`item_closed`、`item_column_changed`、`code_changes_requested`、`code_review_approved` 或 `pull_request_merged`)、`enabled` 開關、`filters`(`issue_type`、`source_column_id`、`target_column_id`、`label_ids`)以及 `actions`(`column_id`、`add_label_ids`、`remove_label_ids`、`issue_state`)。權限規則與介面操作相同,詳見[權限](#權限)。
## 範例:自動分流新的錯誤回報
以下設定能讓錯誤議題自動落在待處理區: