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`)。权限规则与界面操作相同,参见[权限](#权限)。
## 示例:自动分流新的缺陷报告
以下工作流可以让缺陷报告自动进入待处理区: