@coda-console/review 2.14.0 → 2.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.coda/workflows/simple.bpmn +21 -9
- package/README.md +12 -9
- package/package.json +1 -1
- package/scripts/simple.mjs +23 -6
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
2
|
<!-- 简易开发(README.md「简易开发」):主 Agent 自己把活干完,你在会话里开启它,流程推送、检查、评审一次,你验收、批准后合并。
|
|
3
|
-
|
|
3
|
+
准备分支:改动交在哪条分支上由发起的 Agent 定,给了(或会话所在的)就用它;都没有时从目标分支的最新提交替它开一条。
|
|
4
|
+
交上改动:第一张任务交给主 Agent,不叫醒它,随会话的下一条输入告诉它;它把改动提交到那条分支,答复改动汇报。
|
|
4
5
|
推送:流程把那个分支的最新提交推到自己的分支 simple/<运行>,开 PR 到目标分支;之后每次修改都推同一个分支、更新同一个 PR。
|
|
5
6
|
检查:在这个提交上调用项目声明为检查的流程(coda:kind="check"),没通过交回主 Agent。
|
|
6
7
|
评审:评审方(发起时选的,没选按设置「评审组合」)在只读会话里评审一次;要求修改交回主 Agent,它改,或写明不改的理由。之后只重跑检查,不评第二轮。
|
|
@@ -10,18 +11,29 @@
|
|
|
10
11
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="simple-definitions" targetNamespace="https://coda.pub/plugins/review">
|
|
11
12
|
<process id="simple" name="简易开发" isExecutable="true" coda:kind="develop" coda:title="简易开发">
|
|
12
13
|
<extensionElements>
|
|
13
|
-
<coda:input name="branch" label="分支" type="branch" defaultFrom="session.branch"
|
|
14
|
+
<coda:input name="branch" label="分支" type="branch" defaultFrom="session.branch" description="主 Agent 提交改动的分支,默认是会话所在的分支;都没有时流程从目标分支替它开 agent/simple-<运行 ID>" />
|
|
14
15
|
<coda:input name="reviewer" label="评审方" type="agent" description="不选按插件设置「评审组合」:Claude 写的由 Codex 评,反之亦然" />
|
|
15
16
|
<coda:input name="devices" label="设备验收" type="boolean" default="false" description="改了客户端、要在 Mac 或 iPhone 上验收时打开" />
|
|
16
17
|
<coda:input name="device" label="验收设备" default="" description="测试机设备名,如 duo-testbed;验收期间独占它;留空不占设备" />
|
|
17
18
|
<coda:input name="base" label="目标分支" default="" description="留空用仓库默认分支" />
|
|
18
19
|
</extensionElements>
|
|
19
20
|
<startEvent id="start" />
|
|
20
|
-
<sequenceFlow id="start-
|
|
21
|
+
<sequenceFlow id="start-lane" sourceRef="start" targetRef="lane" />
|
|
22
|
+
|
|
23
|
+
<!-- 改动交在哪条分支上:发起时给了(或会话所在的)就用它;没有就从目标分支的最新提交开一条,告诉主 Agent 在哪个仓库。 -->
|
|
24
|
+
<scriptTask id="lane" name="准备分支" coda:timeout="5" scriptFormat="bash">
|
|
25
|
+
<extensionElements>
|
|
26
|
+
<coda:env name="BRANCH" value="=inputs.branch" />
|
|
27
|
+
<coda:env name="BASE" value="=inputs.base" />
|
|
28
|
+
<coda:output name="branch" /><coda:output name="made" /><coda:output name="base" /><coda:output name="repo" />
|
|
29
|
+
</extensionElements>
|
|
30
|
+
<script>node "${CODA_PLUGIN_PATH}/scripts/simple.mjs" lane</script>
|
|
31
|
+
</scriptTask>
|
|
32
|
+
<sequenceFlow id="lane-report" sourceRef="lane" targetRef="report" />
|
|
21
33
|
|
|
22
34
|
<userTask id="report" name="交上改动" coda:wake="false" coda:noteLabel="写给用户的改动汇报">
|
|
23
35
|
<documentation>这次用简易开发:你自己把这次的改动做完,流程推送、跑项目检查、请{{if inputs.reviewer = null then "评审方" else " " + inputs.reviewer.agent + " "}}评审一次,用户验收、批准后合并。
|
|
24
|
-
把改动提交到分支 {{
|
|
36
|
+
把改动提交到分支 {{lane.branch}}(不用推送、不用开 PR),再答复。{{if lane.made = true then "这条分支是流程从 " + lane.base + " 的最新提交替你开的,在仓库 " + lane.repo + " 里:在那里用 git worktree add 开你自己的工作树,改动提交到这条分支。" else ""}}备注必填,是写给用户的改动汇报,会放在 PR 描述和批准卡最上面。约 8 行以内,只写用户能感知的变化和动到的端,不放实现细节、测试数量、文件清单,不贴代码:
|
|
25
37
|
做了什么
|
|
26
38
|
- …(3~5 条)
|
|
27
39
|
需要你知道:…(风险、没做的、顺带改的;没有写「无」)
|
|
@@ -34,7 +46,7 @@
|
|
|
34
46
|
<!-- 每次交回改动都从这里走:读出分支的最新提交,推到流程的分支。没有新提交、或分支读不到,交回主 Agent。 -->
|
|
35
47
|
<scriptTask id="push" name="推送改动" coda:timeout="5" scriptFormat="bash">
|
|
36
48
|
<extensionElements>
|
|
37
|
-
<coda:env name="BRANCH" value="=
|
|
49
|
+
<coda:env name="BRANCH" value="=lane.branch" />
|
|
38
50
|
<coda:env name="BASE" value="=inputs.base" />
|
|
39
51
|
<coda:env name="REPORT" value="=report" />
|
|
40
52
|
<coda:output name="route" /><coda:output name="feedback" /><coda:output name="head" /><coda:output name="lane" />
|
|
@@ -106,7 +118,7 @@
|
|
|
106
118
|
{{review.rules}}
|
|
107
119
|
|
|
108
120
|
请照这些规则独立核实:没有可达的触发路径的、属于规则说不报的、按严重程度的定义其实低于阻塞级别的,都不算成立。
|
|
109
|
-
成立的就修改,提交到分支 {{
|
|
121
|
+
成立的就修改,提交到分支 {{lane.branch}},选「已修改」,备注写改了什么。不改的选「不改」,备注写明理由和依据的规则,会写进 PR 与批准卡,由用户批准时判断。之后只重跑检查,不再评审。</documentation>
|
|
110
122
|
<extensionElements>
|
|
111
123
|
<coda:choice id="fixed" name="已修改" primary="true" />
|
|
112
124
|
<coda:choice id="kept" name="不改" note="required" />
|
|
@@ -142,7 +154,7 @@
|
|
|
142
154
|
<documentation>要在设备上验收的提交是 {{pr.head}}(PR {{pr.url}})。
|
|
143
155
|
只装改到的那一端:改了 Mac 用 workflow_run 发起 mac-preview-install,改了 iPhone 发起 ios-preview-install,都传 commit="{{pr.head}}"。等发起的安装都成功后答复「已装好」;有失败先处理,不能把发起当作装好。
|
|
144
156
|
{{if inputs.device = "" then "" else "发起 ios-preview-install 时还要传 device=\"" + inputs.device + "\"。安装运行会借本段占着的设备,不另排队。"}}
|
|
145
|
-
需要先修改时,修改并提交到分支 {{
|
|
157
|
+
需要先修改时,修改并提交到分支 {{lane.branch}},选「已修改」,备注写改了什么。预览只装客户端,不从这个分支部署后端。</documentation>
|
|
146
158
|
<extensionElements>
|
|
147
159
|
<coda:choice id="installed" name="已装好" primary="true" />
|
|
148
160
|
<coda:choice id="changed" name="已修改" note="required" />
|
|
@@ -223,7 +235,7 @@
|
|
|
223
235
|
<userTask id="fix" name="修改后答复" coda:noteLabel="改了什么">
|
|
224
236
|
<documentation>{{problem.text}}
|
|
225
237
|
|
|
226
|
-
修改并提交到分支 {{
|
|
238
|
+
修改并提交到分支 {{lane.branch}},再答复,备注写改了什么。流程会推送、重跑项目检查,更新同一个 PR。</documentation>
|
|
227
239
|
<extensionElements><coda:choice id="done" name="已修改" primary="true" /></extensionElements>
|
|
228
240
|
</userTask>
|
|
229
241
|
<sequenceFlow id="fix-push" sourceRef="fix" targetRef="push" />
|
|
@@ -266,7 +278,7 @@
|
|
|
266
278
|
<scriptTask id="merge" name="合并" coda:timeout="10" coda:status="合并中" scriptFormat="bash">
|
|
267
279
|
<extensionElements>
|
|
268
280
|
<coda:env name="METHOD" value="=vars.review.mergeMethod" />
|
|
269
|
-
<coda:env name="BRANCH" value="=
|
|
281
|
+
<coda:env name="BRANCH" value="=lane.branch" />
|
|
270
282
|
<coda:output name="route" /><coda:output name="commit" />
|
|
271
283
|
</extensionElements>
|
|
272
284
|
<script>node "${CODA_PLUGIN_PATH}/scripts/simple.mjs" merge</script>
|
package/README.md
CHANGED
|
@@ -123,20 +123,23 @@ prompts/principles/ 评审重点,一项一段,按设置取
|
|
|
123
123
|
|
|
124
124
|
| 输入 | 用途 |
|
|
125
125
|
| --- | --- |
|
|
126
|
-
| `branch` | 「分支」,主 Agent 提交改动的分支,默认是会话所在的分支(`defaultFrom="session.branch"
|
|
126
|
+
| `branch` | 「分支」,主 Agent 提交改动的分支,默认是会话所在的分支(`defaultFrom="session.branch"`);都没有时由「准备分支」开一条 |
|
|
127
127
|
| `reviewer` | 「评审方」,一组 Agent 选择(流程参数的 `agent` 类型),表单里用 App 的 Agent 选择器;不选按设置「评审组合」(`review.reviewers`),与 PR 生命流程相同 |
|
|
128
128
|
| `devices` | 「设备验收」,默认关;改了客户端、要在 Mac 或 iPhone 上验收时打开 |
|
|
129
129
|
| `device` | 「验收设备」,如 `duo-testbed`,默认空;验收期间独占这台设备 |
|
|
130
130
|
| `base` | 「目标分支」,留空用仓库默认分支 |
|
|
131
131
|
|
|
132
|
-
1.
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
132
|
+
1. **准备分支**:改动交在哪条分支上,由发起的 Agent 负责:开在别的目录、或要指定分支时,它自己开好分支,发起时传 `branch`。传了(或会话所在的分支)就用它;
|
|
133
|
+
都没有时(被「开工」从别的目录调用,会话不在这个仓库),流程从目标分支的最新提交开 `agent/simple-<运行 ID>`,在第一张任务里告诉主 Agent 分支名和仓库路径,
|
|
134
|
+
主 Agent 自己在那里开工作树。只开分支,不建工作树、不清理;再走到这一步时分支已在就沿用。
|
|
135
|
+
2. **交上改动**:第一张任务交给主 Agent。你在会话里直接开启时,这张任务不叫醒它(`coda:wake="false"`),随你在会话里的下一条消息告诉它:你开启了简易开发、它要做什么;Agent 经「开工」发起时,你在开工卡上选定后流程把下一步交给它,不必等你的下一条消息。它把改动提交到上一步定下的分支,答复时备注必填,是写给你的改动汇报,放在 PR 描述和批准卡最上面。
|
|
136
|
+
3. **推送**:流程读出这条分支的最新提交,推到运行自己的分支 `simple/<运行 ID>`(主 Agent 的分支不推),开 PR 到目标分支,标题是这次改动的第一个提交的标题;之后每次修改都推同一个分支(强推,主 Agent 可以变基)、更新同一个 PR。分支读不到、没有比目标分支新的提交,或答复「已修改」却没有新提交的,交回主 Agent。
|
|
137
|
+
4. **检查**:在这个提交上调用项目的 `coda:kind="check"`,没通过交回主 Agent,写明运行,它用 `workflow_status` 读失败的步骤和日志。
|
|
138
|
+
5. **评审一次**:`reviewer`(或评审组合里的那一行)在只读会话里评审,规则、阻塞级别、评审重点与 PR 生命流程相同,结论也写成 PR 评论。要求修改时交主 Agent「处理评审意见」:改了就提交、选「已修改」;不改选「不改」,必须写明理由,写进 PR 和批准卡,由你批准时判断。之后只重跑检查,不评第二轮。
|
|
139
|
+
6. **设备验收**(`devices` 打开时):主 Agent 只装改到的那一端(`mac-preview-install`、`ios-preview-install`,传 PR 的提交),你在设备上验收;「不行」必须附言(写意见或附截图),交回主 Agent 修改,改好后重新验收。验收过的提交之后又改了,也要重新验收。
|
|
140
|
+
7. **合并前检查与 GitHub 检查**:在 PR 的提交上跑一次 `coda:kind="premerge"`,再等 GitHub 上的检查都有结果;没通过交回主 Agent。
|
|
141
|
+
8. **批准合并**:卡片上是改动汇报、评审结论、不改的理由与检查结果。「合并」按 `review.mergeMethod` 合并这个提交,可勾部署、发布预览版、发布正式版(项目有对应流程时出现,默认按 `review.mergeOptions`)与「全部完成后通知 Agent」(默认勾选);「暂不合并」必须写明原因,交给主 Agent 跟进。合并时删除运行自己的分支;与目标分支冲突时交回主 Agent 合入、解冲突,再重跑检查、重新批准。其余合并失败让这一步失败。
|
|
142
|
+
9. **部署与发布**:合并后在合并提交上按勾选调用部署;发布前请主 Agent 写更新说明,再调用发布流程。
|
|
140
143
|
|
|
141
144
|
所有交回主 Agent 修改的(评审意见除外)都是同一张「修改后答复」,写明要改的是什么;答复后从推送重新走。进度存在本次运行的产物 `simple.json` 里。需要支持流程参数 `agent` 类型、`coda:wake` 与 `note="required"` 的 Coda。
|
|
142
145
|
|
package/package.json
CHANGED
package/scripts/simple.mjs
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
|
-
// The steps of the simple development flow (../.coda/workflows/simple.bpmn「简易开发」) other than the review itself:
|
|
2
|
-
// the lead agent hands in
|
|
3
|
-
// later change. What the run has seen so far — the report, the head pushed, the review,
|
|
4
|
-
// what the agent is to change next — stays in the run's artifacts, every step's
|
|
1
|
+
// The steps of the simple development flow (../.coda/workflows/simple.bpmn「简易开发」) other than the review itself: the
|
|
2
|
+
// branch the lead agent hands its change in on, and what it hands in pushed from there to the run's own branch and opened as
|
|
3
|
+
// one pull request, updated by every later change. What the run has seen so far — the report, the head pushed, the review,
|
|
4
|
+
// what the user accepted on a device, what the agent is to change next — stays in the run's artifacts, every step's
|
|
5
|
+
// checkout being its own.
|
|
5
6
|
import { execFileSync, spawnSync } from 'node:child_process';
|
|
6
7
|
import { existsSync, readFileSync, writeFileSync } from 'node:fs';
|
|
7
|
-
import { join } from 'node:path';
|
|
8
|
+
import { dirname, join } from 'node:path';
|
|
8
9
|
import { json, output } from './step.mjs';
|
|
9
10
|
|
|
10
11
|
const env = process.env, action = process.argv[2];
|
|
@@ -17,10 +18,26 @@ const save = value => writeFileSync(statePath, JSON.stringify(value));
|
|
|
17
18
|
// What the agent is asked to change: kept for the next 「修改后答复」 (`problem`).
|
|
18
19
|
const ask = (value, text) => { save({ ...value, feedback: text }); output('feedback', text); };
|
|
19
20
|
|
|
21
|
+
const target = () => env.BASE || gh('repo', 'view', '--json', 'defaultBranchRef', '--jq', '.defaultBranchRef.name');
|
|
22
|
+
|
|
20
23
|
switch (action) {
|
|
24
|
+
case 'lane': {
|
|
25
|
+
// The agent that started the run names its branch (or works on its session's); given none, one is cut here from the
|
|
26
|
+
// latest target for it, kept as it is when the run goes over this again. Only the branch: the agent opens its own
|
|
27
|
+
// worktree on it, in the repository this step's checkout shares its branches with.
|
|
28
|
+
if (env.BRANCH) { output('branch', env.BRANCH); output('made', 'false'); break; }
|
|
29
|
+
const base = target(), branch = `agent/simple-${env.GITHUB_RUN_ID}`;
|
|
30
|
+
git('fetch', '--quiet', 'origin', base);
|
|
31
|
+
if (!tryGit('rev-parse', '--verify', '--quiet', `refs/heads/${branch}`)) git('branch', '--no-track', branch, 'FETCH_HEAD');
|
|
32
|
+
output('branch', branch);
|
|
33
|
+
output('made', 'true');
|
|
34
|
+
output('base', base);
|
|
35
|
+
output('repo', dirname(git('rev-parse', '--path-format=absolute', '--git-common-dir')));
|
|
36
|
+
break;
|
|
37
|
+
}
|
|
21
38
|
case 'push': {
|
|
22
39
|
// The first time, before a pull request: the report the agent wrote, which heads the pull request and the approval card.
|
|
23
|
-
const now = state ?? { base:
|
|
40
|
+
const now = state ?? { base: target(),
|
|
24
41
|
lane: `simple/${env.GITHUB_RUN_ID}`, head: '', pr: '', reviewed: false, deviceHead: '' };
|
|
25
42
|
if (!now.pr) now.report = (json('REPORT', {}).note ?? '').trim();
|
|
26
43
|
const back = now.pr ? 'fix' : 'report', branch = env.BRANCH;
|