2.8 KiB
2.8 KiB
issue +batch-comment
前置条件: 先阅读
../gitlink-shared/SKILL.md了解认证、全局参数和安全规则。
批量给多个 Issue 添加评论。支持直接传入 Issue 编号列表、从 CSV 读取 Issue 编号,以及用 --dry-run 安全预览。
Issue 编号说明:
--numbers使用的是网页 URL 中可见的 Issue 编号,即 v1 API 的project_issues_index,不是数据库内部 ID。
命令
# 预览,不修改数据
gitlink-cli issue +batch-comment --owner Gitlink --repo forgeplus --numbers 42,43 --body "请确认该 Issue 是否仍需处理。" --dry-run
# 按 Issue 编号批量添加评论
gitlink-cli issue +batch-comment --owner Gitlink --repo forgeplus --numbers 42,43 --body "该 Issue 长期无更新,如仍需处理请回复。"
# 从 CSV 文件读取 Issue 编号
gitlink-cli issue +batch-comment --owner Gitlink --repo forgeplus --from issues.csv --body "该 Issue 长期无更新,如仍需处理请回复。"
CSV 格式
CSV 文件可以包含 number、issue_number 或 project_issues_index 列:
number,title
42,stale issue
43,duplicate issue
如果没有表头,则默认第一列是 Issue 编号:
42,stale issue
43,duplicate issue
参数
| 参数 | 必填 | 说明 |
|---|---|---|
--numbers, -n |
否 | 逗号分隔的 Issue 编号,例如 1,2,3 |
--from |
否 | 包含 Issue 编号的 CSV 文件 |
--body, -b |
是 | 评论内容 |
--dry-run |
否 | 仅预览计划操作,不添加评论 |
--owner |
否 | 仓库所有者(自动从 git remote 解析) |
--repo |
否 | 仓库名称(自动从 git remote 解析) |
--format |
否 | 输出格式: json/table/yaml |
--debug |
否 | 开启调试输出 |
--numbers 和 --from 至少提供一个。两者同时提供时,会按顺序合并并去重。
输出
命令会输出批量操作汇总:
{
"repository": "Gitlink/forgeplus",
"dry_run": true,
"total": 2,
"succeeded": 2,
"failed": 0,
"results": [
{"number": "42", "action": "comment", "status": "planned"},
{"number": "43", "action": "comment", "status": "planned"}
]
}
API
每个 Issue 使用 v1 评论接口:
POST /v1/{owner}/{repo}/issues/{number}/journals
Body: { "notes": <comment body> }
Workflow
- 与用户确认目标仓库、要评论的 Issue 编号和评论内容。
- 先执行
--dry-run并展示计划结果。 - 用户确认后,再执行不带
--dry-run的命令。 - 汇报成功数量、失败数量和失败原因。
[!CAUTION] 不带
--dry-run是 写操作,执行前必须确认用户意图。