@coda-console/review 3.2.0 → 3.3.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/pull-request.bpmn +6 -6
- package/.coda/workflows/simple.bpmn +5 -4
- package/README.md +12 -6
- package/package.json +1 -1
- package/scripts/checks.mjs +1 -1
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
2
|
<!-- PR 生命流程(docs/plugins.md「内置插件:PR 生命流程」):会话开的 PR 从开出来起一条运行,走到合并或关闭才结束。
|
|
3
3
|
草稿:等作者标记为可评审。
|
|
4
|
-
|
|
4
|
+
检查:在这个提交上调用项目加入挂点 check 的流程(检查),再等它在 GitHub 上的检查都有结果;有没通过的交给开 PR 的会话。
|
|
5
5
|
评审:另一家 Agent 评审这个版本;要求修改交给开 PR 的会话,它不同意交给你仲裁。有新提交就从头再来。
|
|
6
6
|
叠放:base 不是默认分支的不合并,等 base 改过去再接着走。
|
|
7
|
-
|
|
7
|
+
合并:请你批准,再在这个提交上调用项目加入挂点 premerge 的流程(合并前检查),都通过才合并;没通过或 GitHub 没合并就交给开 PR 的会话,
|
|
8
8
|
它推了新提交、评审通过后按你的批准合并,不再问。
|
|
9
9
|
删除分支:你勾选后,等 GitHub 确认合并,再删除仍指向该提交的远程源分支;本地分支与工作树保留。
|
|
10
10
|
合并后的流程:合并后在合并提交上运行你在批准卡上勾的流程(项目里加入挂点 merged 的)。
|
|
@@ -69,7 +69,7 @@
|
|
|
69
69
|
<boundaryEvent id="closed-while-drafted" name="PR 关闭" attachedToRef="drafting"><messageEventDefinition messageRef="closed" /></boundaryEvent>
|
|
70
70
|
<sequenceFlow id="drafted-closed" sourceRef="closed-while-drafted" targetRef="ended" />
|
|
71
71
|
|
|
72
|
-
<!-- 检查:机器检查便宜,先过了它们再请 Agent
|
|
72
|
+
<!-- 检查:机器检查便宜,先过了它们再请 Agent 评审。项目在自己的仓库里让检查流程加入挂点 check:这里在这个提交上调用它们,
|
|
73
73
|
一个没通过(运行失败)就交给开 PR 的会话;都通过了,再等这个提交在 GitHub 上的全部检查(项目检查写的状态、GitHub Actions 等)有结果,
|
|
74
74
|
它们的一句话结论交给评审方、写在批准卡上。会话推了新提交就答复「已推送新版本」,等新提交从头再来;重跑外部检查或处理好别的后答复,再跑一遍。 -->
|
|
75
75
|
<subProcess id="checking" name="检查">
|
|
@@ -77,7 +77,7 @@
|
|
|
77
77
|
<sequenceFlow id="c-in" sourceRef="checking-in" targetRef="run-checks" />
|
|
78
78
|
<serviceTask id="run-checks" name="跑项目的检查" coda:action="run-workflows" coda:status="跑项目的检查">
|
|
79
79
|
<extensionElements>
|
|
80
|
-
<coda:param name="
|
|
80
|
+
<coda:param name="hook" value="check" />
|
|
81
81
|
<coda:param name="commit" value="=github.event.pull_request.head.sha" />
|
|
82
82
|
</extensionElements>
|
|
83
83
|
</serviceTask>
|
|
@@ -383,11 +383,11 @@ GitHub 上各项检查用 `gh pr checks {{github.event.pull_request.html_url}}`
|
|
|
383
383
|
</scriptTask>
|
|
384
384
|
<sequenceFlow id="to-premerge" sourceRef="approval" targetRef="premerge" />
|
|
385
385
|
|
|
386
|
-
<!--
|
|
386
|
+
<!-- 合并前检查:每个版本都跑嫌贵的验证(如后端全套),项目让它加入挂点 premerge,批准后在要合并的提交上只跑一次。
|
|
387
387
|
没通过交给开 PR 的会话:推了新提交答复「已推送新版本」,等新提交从头再来,评审通过后按原批准合并;检查本身出了问题,处理好后答复,再跑一遍。 -->
|
|
388
388
|
<serviceTask id="premerge" name="合并前检查" coda:action="run-workflows" coda:status="合并前检查">
|
|
389
389
|
<extensionElements>
|
|
390
|
-
<coda:param name="
|
|
390
|
+
<coda:param name="hook" value="premerge" />
|
|
391
391
|
<coda:param name="commit" value="=reviewing.head" />
|
|
392
392
|
</extensionElements>
|
|
393
393
|
</serviceTask>
|
|
@@ -3,14 +3,15 @@
|
|
|
3
3
|
准备分支:改动交在哪条分支上由发起的 Agent 定,给了(或会话所在的)就用它;都没有时从目标分支的最新提交替它开一条。
|
|
4
4
|
交上改动:第一张任务交给主 Agent,不叫醒它,随会话的下一条输入告诉它;它把改动提交到那条分支,答复改动汇报。
|
|
5
5
|
推送:流程把那个分支的最新提交推到自己的分支 simple/<运行>,开 PR 到目标分支;之后每次修改都推同一个分支、更新同一个 PR。
|
|
6
|
-
|
|
6
|
+
检查:在这个提交上调用项目加入挂点 check 的流程(检查),没通过交回主 Agent。
|
|
7
7
|
评审:评审方(发起时选的,没选按设置「评审组合」)在只读会话里评审一次;要求修改交回主 Agent,它改,或写明不改的理由。之后只重跑检查,不评第二轮。
|
|
8
8
|
设备验收(可选):主 Agent 装预览版,你在设备上验收,「不行」交回主 Agent。
|
|
9
9
|
合并前检查、GitHub 检查都通过后请你批准;合并后运行你勾选的合并后流程(挂点 merged)。BPMN 2.0,由 Coda 执行(docs/workflows.md)。 -->
|
|
10
10
|
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:coda="https://coda.pub/schema/bpmn/1.0"
|
|
11
11
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="simple-definitions" targetNamespace="https://coda.pub/plugins/review">
|
|
12
|
-
<process id="simple" name="简易开发" isExecutable="true" coda:
|
|
12
|
+
<process id="simple" name="简易开发" isExecutable="true" coda:title="简易开发">
|
|
13
13
|
<extensionElements>
|
|
14
|
+
<coda:join hook="develop" />
|
|
14
15
|
<coda:input name="branch" label="分支" type="branch" defaultFrom="session.branch" description="主 Agent 提交改动的分支,默认是会话所在的分支;都没有时流程从目标分支替它开 agent/simple-<运行 ID>" />
|
|
15
16
|
<coda:input name="reviewer" label="评审方" type="agent" description="不选按插件设置「评审组合」:Claude 写的由 Codex 评,反之亦然" />
|
|
16
17
|
<coda:input name="devices" label="设备验收" type="boolean" default="false" description="改了客户端、要在 Mac 或 iPhone 上验收时打开" />
|
|
@@ -60,7 +61,7 @@
|
|
|
60
61
|
<sequenceFlow id="push-checks" sourceRef="pushed" targetRef="checks" />
|
|
61
62
|
|
|
62
63
|
<serviceTask id="checks" name="项目检查" coda:action="run-workflows" coda:status="跑项目的检查">
|
|
63
|
-
<extensionElements><coda:param name="
|
|
64
|
+
<extensionElements><coda:param name="hook" value="check" /><coda:param name="commit" value="=push.head" /></extensionElements>
|
|
64
65
|
</serviceTask>
|
|
65
66
|
<boundaryEvent id="checks-failed" name="没通过" attachedToRef="checks"><errorEventDefinition /></boundaryEvent>
|
|
66
67
|
<sequenceFlow id="checks-problem" sourceRef="checks-failed" targetRef="checks-feedback" />
|
|
@@ -201,7 +202,7 @@
|
|
|
201
202
|
<sequenceFlow id="acceptance-premerge" sourceRef="after-acceptance" targetRef="premerge" />
|
|
202
203
|
|
|
203
204
|
<serviceTask id="premerge" name="合并前检查" coda:action="run-workflows" coda:status="合并前检查">
|
|
204
|
-
<extensionElements><coda:param name="
|
|
205
|
+
<extensionElements><coda:param name="hook" value="premerge" /><coda:param name="commit" value="=pr.head" /></extensionElements>
|
|
205
206
|
</serviceTask>
|
|
206
207
|
<boundaryEvent id="premerge-failed" name="没通过" attachedToRef="premerge"><errorEventDefinition /></boundaryEvent>
|
|
207
208
|
<sequenceFlow id="premerge-problem" sourceRef="premerge-failed" targetRef="premerge-feedback" />
|
package/README.md
CHANGED
|
@@ -47,13 +47,15 @@ prompts/principles/ 评审重点,一项一段,按设置取
|
|
|
47
47
|
|
|
48
48
|
3.2.0 给「填写合并后流程要的文字」加了第二个选项「这一项这次不跑」:不写这段文字,要它的流程这次都不跑,其余勾了的照常运行(下文「挂点 merged」)。
|
|
49
49
|
|
|
50
|
+
3.3.0 不再用流程类别([Coda #2521](https://github.com/coda-console/coda/issues/2521) 第 5 步):检查、合并前检查改为调用加入挂点 `check`、`premerge` 的流程(`run-workflows hook=…`),简易开发改为加入挂点 `develop`,不再写 `coda:kind`。项目里检查流程要显式写 `<coda:join hook="…"/>`。
|
|
51
|
+
|
|
50
52
|
## 项目提供的部分
|
|
51
53
|
|
|
52
54
|
插件管流程,项目在自己的仓库里提供四样,跟着代码走:
|
|
53
55
|
|
|
54
56
|
- **评审准则**:`.coda/review.md`,从 PR 的 **base 提交**读取,交给评审方,也写进「处理评审意见」交给开 PR 的会话。PR 改它只从合并后的评审起生效;文件不存在就省略,读不出 base 提交时这次评审失败。
|
|
55
|
-
-
|
|
56
|
-
-
|
|
57
|
+
- **检查**:仓库里加入挂点 `check` 的流程(第 2 步),每个版本都跑。
|
|
58
|
+
- **合并前检查**:加入挂点 `premerge` 的流程(第 5 步),你批准后在要合并的提交上只跑一次;每个版本都跑嫌贵的验证(如整套回归)放这里。
|
|
57
59
|
- **合并后的流程**:加入挂点 `merged` 的流程(第 6 步,下文「挂点 merged」),如部署、发布预览版、发布正式版。
|
|
58
60
|
|
|
59
61
|
## 流程
|
|
@@ -61,7 +63,7 @@ prompts/principles/ 评审重点,一项一段,按设置取
|
|
|
61
63
|
1. **草稿**:PR 是草稿就等作者标记为可评审(`pull_request.ready_for_review`);有新提交时按它带来的草稿状态重新判断,关闭则结束。
|
|
62
64
|
推送和标记为可评审落在 Coda 的同一次查看之间时,只有新提交这一个事件,它说已不是草稿就去评审。
|
|
63
65
|
2. **检查**:机器检查便宜,先过了它们再请 Agent 评审。
|
|
64
|
-
- 「跑项目的检查」在 PR
|
|
66
|
+
- 「跑项目的检查」在 PR 的提交上调用项目加入挂点 `check` 的流程并等它们结束;没通过的检查让自己的运行失败,有一个失败就交给开 PR 的会话。
|
|
65
67
|
检查可以同时往提交上写一条 GitHub 状态,一句话结论在描述里。项目没有检查就直接过去。
|
|
66
68
|
- 「等 GitHub 检查」(`checks.mjs`)再每隔几秒读一次 `gh pr checks`,等这个提交在 GitHub 上的检查(commit status 与 check run,包括 GitHub Actions)都有了结果,
|
|
67
69
|
一小时没等到这一步失败。都通过就去评审,各项的一句话结论交给评审方、写在批准卡上;有没通过的同样交给开 PR 的会话。
|
|
@@ -96,7 +98,7 @@ prompts/principles/ 评审重点,一项一段,按设置取
|
|
|
96
98
|
主按钮「合并」按默认值提交;「更多」里的勾选项依次是「合并后删除远程分支」、这些流程(默认勾不勾由各自的 `default` 定)、「全部完成后通知 Agent」,删分支与通知初始按 `review.mergeOptions` 勾选。
|
|
97
99
|
勾上要文字的流程(如发布要发布说明)时卡上出现对应的输入框,可以不写。
|
|
98
100
|
另有「让 Agent 处理评审意见」:连同你的备注交给开 PR 的会话「处理你交付的评审意见」,它推送后重新评审、再请你批准,它做不了就回到批准卡;以及「关闭 PR」(`gh pr close`)。
|
|
99
|
-
- 「合并前检查」:你选了合并后,先「记下批准」(`approval.mjs
|
|
101
|
+
- 「合并前检查」:你选了合并后,先「记下批准」(`approval.mjs`):批准的时刻,和你勾的删分支、合并后的流程(连同卡上写的文字、没写的输入)、通知(合并后都照它做),再在评审通过的提交上调用项目加入挂点 `premerge` 的流程(合并前检查)并等它们结束;
|
|
100
102
|
项目没有就直接过去。有一个没通过就交给开 PR 的会话「合并前检查没通过:处理后答复」:改动导致的就推送新提交,照常检查、评审,通过后按你这次的选择合并,不再问;
|
|
101
103
|
检查本身出了问题就处理好后答复,再跑一遍。它做不了交给你「合并前检查没通过:等你处理」。合并没成功后重试合并不再跑合并前检查(同一个提交已经通过)。
|
|
102
104
|
需要认识 `premerge` 这一类的 Coda。
|
|
@@ -169,15 +171,19 @@ GitHub 插件的 PR 观察看到这样的 PR,发 `foreign_pull_request.opened`
|
|
|
169
171
|
主 Agent 自己在那里开工作树。只开分支,不建工作树、不清理;再走到这一步时分支已在就沿用。
|
|
170
172
|
2. **交上改动**:第一张任务交给主 Agent。你在会话里直接开启时,这张任务不叫醒它(`coda:wake="false"`),随你在会话里的下一条消息告诉它:你开启了简易开发、它要做什么;Agent 填好交你确认的,你在开工卡上开工后,任务随需求消息交给它。它把改动提交到上一步定下的分支,答复时备注必填,是写给你的改动汇报,放在 PR 描述和批准卡最上面。
|
|
171
173
|
3. **推送**:流程读出这条分支的最新提交,推到运行自己的分支 `simple/<运行 ID>`(主 Agent 的分支不推),开 PR 到目标分支,标题是这次改动的第一个提交的标题;之后每次修改都推同一个分支(强推,主 Agent 可以变基)、更新同一个 PR。分支读不到、没有比目标分支新的提交,或答复「已修改」却没有新提交的,交回主 Agent。
|
|
172
|
-
4.
|
|
174
|
+
4. **检查**:在这个提交上调用项目加入挂点 `check` 的流程,没通过交回主 Agent,写明运行,它用 `workflow_status` 读失败的步骤和日志。
|
|
173
175
|
5. **评审一次**:`reviewer`(或评审组合里的那一行)在只读会话里评审,规则、阻塞级别、评审重点与 PR 生命流程相同,结论也写成 PR 评论。要求修改时交主 Agent「处理评审意见」:改了就提交、选「已修改」;不改选「不改」,必须写明理由,写进 PR 和批准卡,由你批准时判断。之后只重跑检查,不评第二轮。
|
|
174
176
|
6. **设备验收**(`devices` 打开时):主 Agent 只装改到的那一端(`mac-preview-install`、`ios-preview-install`,传 PR 的提交),你在设备上验收;「不行」必须附言(写意见或附截图),交回主 Agent 修改,改好后重新验收。验收过的提交之后又改了,也要重新验收。
|
|
175
|
-
7. **合并前检查与 GitHub 检查**:在 PR
|
|
177
|
+
7. **合并前检查与 GitHub 检查**:在 PR 的提交上跑一次加入挂点 `premerge` 的流程,再等 GitHub 上的检查都有结果;没通过交回主 Agent。
|
|
176
178
|
8. **批准合并**:卡片上是改动汇报、评审结论、不改的理由、检查结果与 PR。「合并」按 `review.mergeMethod` 合并这个提交,可勾项目里加入挂点 `merged` 的流程(`hook-joiners` 列出,默认由各自声明)与「全部完成后通知 Agent」(默认勾选);「暂不合并」必须写明原因,交给主 Agent 跟进。合并时删除运行自己的分支;与目标分支冲突时交回主 Agent 合入、解冲突,再重跑检查、重新批准。其余合并失败让这一步失败。
|
|
177
179
|
9. **合并后的流程**:合并后在合并提交上运行勾了的;它们要的文字卡上没写的先交主 Agent 逐项补写(下文「挂点 merged」)。
|
|
178
180
|
|
|
179
181
|
所有交回主 Agent 修改的(评审意见除外)都是同一张「修改后答复」,写明要改的是什么;答复后从推送重新走。进度存在本次运行的产物 `simple.json` 里。需要支持流程参数 `agent` 类型、`coda:wake` 与 `note="required"` 的 Coda。
|
|
180
182
|
|
|
183
|
+
## 挂点 check、premerge
|
|
184
|
+
|
|
185
|
+
PR 生命流程与简易开发在一个提交上调用项目加入挂点 `check`(每个版本都跑)、`premerge`(批准后、合并前只跑一次)的流程,传 `commit`,全部运行并等结束,有一个失败就算没通过。项目在检查流程的 `process` 上写 `<coda:join hook="check" />` 或 `<coda:join hook="premerge" />` 加入。简易开发自己加入挂点 `develop`:Coda 在「+」和开工卡上列出加入这个挂点的流程作为开发流程。
|
|
186
|
+
|
|
181
187
|
## 挂点 merged
|
|
182
188
|
|
|
183
189
|
PR 生命流程与简易开发声明挂点 `merged`:合并后要做的事由项目自己的流程(或启用插件的流程)在 `process` 上写 `<coda:join hook="merged" …/>` 加入(Coda 的 `docs/workflows.md`「调用其他流程」),本插件不认识任何一类。约定:
|
package/package.json
CHANGED
package/scripts/checks.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
// Waits for the pull request's checks on GitHub (../.coda/workflows/pull-request.bpmn「等 GitHub 检查」): what GitHub has on
|
|
2
|
-
// its head commit, commit statuses and check runs alike, whoever ran them. The project's own checks (
|
|
2
|
+
// its head commit, commit statuses and check runs alike, whoever ran them. The project's own checks (workflows joining hook check)
|
|
3
3
|
// have ended by now, and wrote what they found as statuses if they do; others (GitHub Actions) are waited for until each
|
|
4
4
|
// has a result. Then it says whether all passed (`passed`) and each check in a line (`lines`, for the reviewer and the
|
|
5
5
|
// approval card). Asked every `EVERY` seconds; it gives up when the step times out.
|