106 lines
5.8 KiB
Markdown
106 lines
5.8 KiB
Markdown
---
|
|
name: streamline-openapi
|
|
description: 提 bug / 导入 Meego 单让 Streamline 在真机上自动修、把本地调研交给 Streamline 接力修、查进展、确认执行。Use when the user wants to 把 bug 提给 Streamline、导入 Meego 单、剩下的交给 Streamline 修、查 Streamline 任务进展、确认执行,or mentions streamline / streamline.bytedance.net 任务链接。
|
|
---
|
|
|
|
# Streamline
|
|
|
|
Streamline 是在真机上复现、修复缺陷的平台:导入或描述一个 bug,它在真机上复现、起草测试方案、修好后提 MR;本地调研了一半的 bug 也可以交给它接着修。
|
|
|
|
**本地改动的真机验证(`streamline verify`)暂时下线。** 用户要「在真机上验证一下这个分支」时,如实告诉他这项能力暂不开放,不要调用 `streamline verify`,也不要拿提单、接力绕过去。
|
|
|
|
所有操作通过本机的 `streamline` 命令完成,**以用户本人的身份**(和他在面板上操作一样)。结果以 JSON 输出到 stdout;出错时 stderr 是 `{"error", "hint"}`,按 hint 做下一步。
|
|
|
|
如果 `streamline` 命令不存在,先安装:
|
|
|
|
```sh
|
|
npm i -g @byted/streamline-skill --registry=https://bnpm.byted.org
|
|
```
|
|
|
|
`streamline` 要访问公司内网(`streamline-internal-api.bytedance.net`)并读写 `~/.config/streamline/`。如果命令因为沙箱拦了网络或文件写入而失败(Codex、Cursor 的默认沙箱都可能这样),按你所在 Agent 的方式申请在沙箱外执行这条命令,不要改用别的办法绕过。
|
|
|
|
## 先确认已登录
|
|
|
|
```sh
|
|
streamline auth status
|
|
```
|
|
|
|
没登录就执行 `streamline auth login`:会打开浏览器,用户在 Streamline 页面上点「授权」后命令才返回(最长等 5 分钟)。**调用时把超时设到 5 分钟以上,或放到后台跑**,并告诉用户去浏览器里点授权。
|
|
|
|
## 提单
|
|
|
|
```sh
|
|
# 从 Meego 工单导入:标题、描述、复现步骤都从工单里取;同一个工单导入过会返回已有任务。
|
|
streamline task import "https://meego.bytedance.com/…"
|
|
|
|
# 直接描述一个 bug:标题和描述必填,平台尽量给。
|
|
streamline task create --title "…" --description "…" --platform android --repro "1. …"
|
|
```
|
|
|
|
- 提单会真的在平台上建任务。执行前把标题、描述、平台给用户确认一遍;信息不够(尤其是复现步骤)先问用户,不要编。
|
|
- `--watchers a,b`:额外接收通知的人或群(邮箱前缀、完整邮箱、`oc_` 群、`ou_` 个人)。用户本人自动接收,不用加。
|
|
- 把返回的 `panelUrl` 给用户。
|
|
|
|
## 接力:把这次会话里的调研交给 Streamline 修
|
|
|
|
用户在当前会话里已经调研过某个 bug(看过日志、读过代码、有了初步结论),想让 Streamline 接着在真机上复现、修复、提 MR 时用这个。Streamline 是异步的:交过去就可以去干别的,之后用 `task get` 看进展。
|
|
|
|
1. **从当前会话里整理一份总结**,按下面的模板写进一个临时文件(如 `/tmp/streamline-handoff.md`)。只写这个 bug 相关的内容:
|
|
|
|
```markdown
|
|
## 现象
|
|
用户实际看到了什么(界面 / 行为 / 报错),在哪个页面、什么条件下。
|
|
|
|
## 复现步骤
|
|
1. …(写到能在真机上照着走;不确定的步骤标出来)
|
|
|
|
## 已确认的事实
|
|
- 每条都附证据:日志或堆栈片段、代码位置(文件 + 函数名)、截图路径。只写亲眼看到的,不写推测。
|
|
|
|
## 怀疑点
|
|
- 位置(文件 + 函数名):为什么怀疑它;把握:高 / 中 / 低
|
|
|
|
## 已排除
|
|
- 查过、确认不是原因的方向,以及为什么。
|
|
|
|
## 建议修法(可选)
|
|
- 如果有想法,写思路,不必写代码。
|
|
```
|
|
|
|
2. **写的时候分清事实和推测。** Streamline 会把整份总结当作重要线索,但会在真机上重新验证每一条;写成事实的推测一旦被推翻,反而会误导它。不要放密钥、Token、账号口令或与 bug 无关的个人信息。
|
|
3. **把总结和标题给用户看一遍,确认后再提交:**
|
|
|
|
```sh
|
|
streamline task handoff --title "…" --platform android --file /tmp/streamline-handoff.md
|
|
```
|
|
|
|
默认会附上当前目录所在仓库的分支和提交号(`--no-git` 不附)。在 bug 所在的代码仓目录里执行最好。
|
|
4. 把返回的 `panelUrl` 给用户,并说明:Streamline 会先自己复现、核实这些线索,再起草测试方案,起草完需要确认执行(`streamline task execute`)。
|
|
|
|
## 查进展
|
|
|
|
```sh
|
|
streamline task list --limit 10 # 用户自己建的单,新的在前
|
|
streamline task get <taskId> # 任意一条单;用户给的面板链接里 task_id= 后面就是 taskId
|
|
```
|
|
|
|
用 `statusLabel`(中文状态)回答;有 `mrUrl` 时一起给出。
|
|
|
|
## 确认执行
|
|
|
|
新建的任务先由评估器起草测试方案(`initializing`),起草完进入 `pending_confirmation`,等人确认后才开始修。用户明确要求开始修复时:
|
|
|
|
```sh
|
|
streamline task execute <taskId>
|
|
```
|
|
|
|
- 只能确认用户**自己建的**单;别人的单返回 403,让用户去面板上操作。
|
|
- 409 按 `error` 的文字告诉用户:还在起草就稍后再试;信息不足要人补充;已在执行就不用再调。
|
|
- 确认前最好让用户在面板上看一眼测试方案(给 `panelUrl`)。
|
|
|
|
## 规矩
|
|
|
|
- 不要读取、打印或转述 `~/.config/streamline/credentials.json`。
|
|
- 不要轮询、不要循环调用:平台在关键节点会飞书通知用户,用户问的时候才查一次。每次建单都会占用真机和编译资源,不要因为没等到结果就重复提交。
|
|
- 用户想让**自己的系统**(服务端程序、机器人)接入 Streamline,那是 API Key 的场景,不在这个 Skill 里办:让他去面板头像菜单「开放平台 API」申请,并看接入文档 https://bytedance.us.larkoffice.com/docx/XUaCdOE7Uo0jOZxaBZbu3Hy8sSf
|