@coda-console/review 2.4.5 → 2.5.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 +42 -8
- package/README.md +9 -4
- package/package.json +3 -3
- package/scripts/merge.mjs +1 -3
|
@@ -4,7 +4,8 @@
|
|
|
4
4
|
检查:在这个提交上调用项目声明为检查的流程(coda:kind="check"),再等它在 GitHub 上的检查都有结果;有没通过的交给开 PR 的会话。
|
|
5
5
|
评审:另一家 Agent 评审这个版本;要求修改交给开 PR 的会话,它不同意交给你仲裁。有新提交就从头再来。
|
|
6
6
|
叠放:base 不是默认分支的不合并,等 base 改过去再接着走。
|
|
7
|
-
|
|
7
|
+
合并:请你批准,再在这个提交上调用项目声明为合并前检查的流程(coda:kind="premerge"),都通过才合并;没通过或 GitHub 没合并就交给开 PR 的会话,
|
|
8
|
+
它推了新提交、评审通过后按你的批准合并,不再问。
|
|
8
9
|
部署与发布:合并后按你勾选的,在合并提交上调用项目里声明为这一类的流程(coda:kind)。
|
|
9
10
|
PR 在 GitHub 上合并或关闭,运行随之结束。也可以手动发起(传 PR 编号或地址),只评审一次。BPMN 2.0,由 Coda 执行(docs/workflows.md)。 -->
|
|
10
11
|
<definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:coda="https://coda.pub/schema/bpmn/1.0"
|
|
@@ -252,16 +253,16 @@ GitHub 上各项检查用 `gh pr checks {{github.event.pull_request.html_url}}`
|
|
|
252
253
|
<boundaryEvent id="closed-while-stacked" name="PR 关闭" attachedToRef="stacking"><messageEventDefinition messageRef="closed" /></boundaryEvent>
|
|
253
254
|
<sequenceFlow id="stacked-closed" sourceRef="closed-while-stacked" targetRef="ended" />
|
|
254
255
|
|
|
255
|
-
<!--
|
|
256
|
+
<!-- 合并:你批准过、之后只是合并前检查没通过或 GitHub 没合并(冲突等),这个版本评审通过就按原批准合并;评审要求修改过(review.changesAt 晚于批准)就再问你。 -->
|
|
256
257
|
<subProcess id="merging" name="合并">
|
|
257
258
|
<startEvent id="merging-in" />
|
|
258
259
|
<sequenceFlow id="m-in" sourceRef="merging-in" targetRef="standing" />
|
|
259
260
|
<exclusiveGateway id="standing" name="按原批准合并吗" default="ask" />
|
|
260
|
-
<sequenceFlow id="as-approved" sourceRef="standing" targetRef="
|
|
261
|
-
<conditionExpression xsi:type="tFormalExpression">=number(
|
|
261
|
+
<sequenceFlow id="as-approved" sourceRef="standing" targetRef="premerge">
|
|
262
|
+
<conditionExpression xsi:type="tFormalExpression">=number(approval.at) > number(review.changesAt)</conditionExpression>
|
|
262
263
|
</sequenceFlow>
|
|
263
264
|
<sequenceFlow id="ask" sourceRef="standing" targetRef="kinds" />
|
|
264
|
-
<!--
|
|
265
|
+
<!-- 批准卡只给项目有的部署、发布:项目在这个提交上没有这一类流程,就没有那个勾选项;有合并前检查的才在卡上说先跑它。 -->
|
|
265
266
|
<serviceTask id="kinds" name="看项目有哪些部署、发布" coda:action="workflow-kinds" />
|
|
266
267
|
<sequenceFlow id="kinds-known" sourceRef="kinds" targetRef="approve" />
|
|
267
268
|
|
|
@@ -276,7 +277,7 @@ GitHub 上各项检查用 `gh pr checks {{github.event.pull_request.html_url}}`
|
|
|
276
277
|
最近一次评审(提交 {{review.head}};点「让 Agent 处理评审意见」才交给开 PR 的会话):
|
|
277
278
|
{{review.report}}
|
|
278
279
|
|
|
279
|
-
「合并」以 {{vars.review.mergeMethod}} 方式合并提交 {{reviewing.head}}
|
|
280
|
+
「合并」以 {{vars.review.mergeMethod}} 方式合并提交 {{reviewing.head}}{{if kinds.premerge then ",先在它上面跑项目的合并前检查,都通过才合并" else ""}}。没合并成(合并前检查没通过,或 GitHub 没合并:冲突、检查没过等)就交给开 PR 的会话处理,它推送的新版本评审通过后按这次的选择合并,不再问你;评审要求修改则这次批准作废。</documentation>
|
|
280
281
|
<extensionElements>
|
|
281
282
|
<coda:choice id="merge" name="合并" primary="true">
|
|
282
283
|
<coda:option id="deploy" name="部署" detail="调用项目里的部署流程" coda:shown="=kinds.deploy" />
|
|
@@ -296,7 +297,7 @@ GitHub 上各项检查用 `gh pr checks {{github.event.pull_request.html_url}}`
|
|
|
296
297
|
<sequenceFlow id="send-it" sourceRef="how" targetRef="handed">
|
|
297
298
|
<conditionExpression xsi:type="tFormalExpression">=approve.chose.send</conditionExpression>
|
|
298
299
|
</sequenceFlow>
|
|
299
|
-
<sequenceFlow id="merge-it" sourceRef="how" targetRef="
|
|
300
|
+
<sequenceFlow id="merge-it" sourceRef="how" targetRef="approval" />
|
|
300
301
|
|
|
301
302
|
<userTask id="handed" name="处理你交付的评审意见" coda:status="处理你交付的评审意见" coda:completeLabel="已处理并推送" coda:rejectLabel="无法处理">
|
|
302
303
|
<documentation>用户要求处理 PR #{{github.event.number}} 的这份评审(提交 {{review.head}}):
|
|
@@ -311,6 +312,40 @@ GitHub 上各项检查用 `gh pr checks {{github.event.pull_request.html_url}}`
|
|
|
311
312
|
<boundaryEvent id="not-handled" name="做不了" attachedToRef="handed"><errorEventDefinition /></boundaryEvent>
|
|
312
313
|
<sequenceFlow id="back-to-approve" sourceRef="not-handled" targetRef="approve" />
|
|
313
314
|
|
|
315
|
+
<!-- 记下你批准的时刻:之后评审再要求修改(review.changesAt 更晚)这次批准才作废。 -->
|
|
316
|
+
<scriptTask id="approval" name="记下批准" coda:timeout="5" coda:checkout="false" scriptFormat="bash">
|
|
317
|
+
<extensionElements><coda:output name="at" /></extensionElements>
|
|
318
|
+
<script>echo "at=$(node -p 'Date.now()')" >> "$GITHUB_OUTPUT"</script>
|
|
319
|
+
</scriptTask>
|
|
320
|
+
<sequenceFlow id="to-premerge" sourceRef="approval" targetRef="premerge" />
|
|
321
|
+
|
|
322
|
+
<!-- 合并前检查:每个版本都跑嫌贵的验证(如后端全套),项目声明为 coda:kind="premerge",批准后在要合并的提交上只跑一次。
|
|
323
|
+
没通过交给开 PR 的会话:推新提交就从头再来,评审通过后按原批准合并;检查本身出了问题,处理好后答复,再跑一遍。 -->
|
|
324
|
+
<serviceTask id="premerge" name="合并前检查" coda:action="run-workflows" coda:status="合并前检查">
|
|
325
|
+
<extensionElements>
|
|
326
|
+
<coda:param name="kind" value="premerge" />
|
|
327
|
+
<coda:param name="commit" value="=reviewing.head" />
|
|
328
|
+
</extensionElements>
|
|
329
|
+
</serviceTask>
|
|
330
|
+
<sequenceFlow id="premerged" sourceRef="premerge" targetRef="merge" />
|
|
331
|
+
<boundaryEvent id="premerge-broke" name="没通过" attachedToRef="premerge"><errorEventDefinition /></boundaryEvent>
|
|
332
|
+
<sequenceFlow id="premerge-to-fix" sourceRef="premerge-broke" targetRef="fix-premerge" />
|
|
333
|
+
<userTask id="fix-premerge" name="合并前检查没通过:处理后答复" coda:status="合并前检查没通过:开 PR 的会话处理中" coda:completeLabel="已处理,再跑检查" coda:rejectLabel="处理不了">
|
|
334
|
+
<documentation>用户已批准合并 PR #{{github.event.number}}({{github.event.pull_request.html_url}}),但提交 {{reviewing.head}} 的合并前检查没通过,还没有合并。没通过的检查列在这次运行页的「调用的流程」里(运行 {{run.id}})。
|
|
335
|
+
|
|
336
|
+
请查明原因。是这次改动导致的就修改、验证并推送新版本(新版本会重新检查、评审,通过后按用户的批准合并),不必答复这个任务;检查本身出了问题(偶发、机器离线),处理好后答复 completed,合并前检查会再跑一遍。做不了就答复 rejected,在 note 里写明原因,交给用户。</documentation>
|
|
337
|
+
</userTask>
|
|
338
|
+
<sequenceFlow id="premerge-again" sourceRef="fix-premerge" targetRef="premerge" />
|
|
339
|
+
<boundaryEvent id="premerge-stuck" name="做不了" attachedToRef="fix-premerge"><errorEventDefinition /></boundaryEvent>
|
|
340
|
+
<sequenceFlow id="to-premerge-user" sourceRef="premerge-stuck" targetRef="premerge-user" />
|
|
341
|
+
<userTask id="premerge-user" name="合并前检查没通过:等你处理" coda:assignee="user" coda:handback="false" coda:status="合并前检查没通过:等你处理" coda:completeLabel="再跑检查" coda:rejectLabel="不再等">
|
|
342
|
+
<documentation>你已批准合并 PR #{{github.event.number}}({{github.event.pull_request.html_url}}),但合并前检查没通过,开 PR 的会话处理不了,理由在这次运行的「合并前检查没通过:处理后答复」任务里;
|
|
343
|
+
没通过的检查见运行页「调用的流程」。
|
|
344
|
+
|
|
345
|
+
处理好后选「再跑检查」;推送新提交也会从头再来。</documentation>
|
|
346
|
+
</userTask>
|
|
347
|
+
<sequenceFlow id="premerge-again-by-user" sourceRef="premerge-user" targetRef="premerge" />
|
|
348
|
+
|
|
314
349
|
<scriptTask id="close" name="关闭 PR" coda:timeout="5" coda:checkout="false" scriptFormat="bash">
|
|
315
350
|
<extensionElements><coda:env name="URL" value="=github.event.pull_request.html_url" /></extensionElements>
|
|
316
351
|
<script>gh pr close "$URL"</script>
|
|
@@ -326,7 +361,6 @@ GitHub 上各项检查用 `gh pr checks {{github.event.pull_request.html_url}}`
|
|
|
326
361
|
<coda:output name="merged" />
|
|
327
362
|
<coda:output name="refused" />
|
|
328
363
|
<coda:output name="reason" />
|
|
329
|
-
<coda:output name="at" />
|
|
330
364
|
<coda:output name="deploy" />
|
|
331
365
|
<coda:output name="release" />
|
|
332
366
|
<coda:output name="releaseKinds" />
|
package/README.md
CHANGED
|
@@ -29,10 +29,11 @@ prompts/principles/ 评审重点,一项一段,按设置取
|
|
|
29
29
|
|
|
30
30
|
## 项目提供的部分
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
插件管流程,项目在自己的仓库里提供四样,跟着代码走:
|
|
33
33
|
|
|
34
34
|
- **评审准则**:`.coda/review.md`,从 PR 的 **base 提交**读取,交给评审方。PR 改它只从合并后的评审起生效;文件不存在就省略,读不出 base 提交时这次评审失败。
|
|
35
|
-
- **检查**:仓库里声明为 `coda:kind="check"` 的流程(第 2
|
|
35
|
+
- **检查**:仓库里声明为 `coda:kind="check"` 的流程(第 2 步),每个版本都跑。
|
|
36
|
+
- **合并前检查**:声明为 `coda:kind="premerge"` 的流程(第 5 步),你批准后在要合并的提交上只跑一次;每个版本都跑嫌贵的验证(如整套回归)放这里。
|
|
36
37
|
- **部署与发布**:声明为 `coda:kind="deploy"`、`preview`、`release` 的流程(第 6 步)。
|
|
37
38
|
|
|
38
39
|
## 流程
|
|
@@ -73,12 +74,16 @@ prompts/principles/ 评审重点,一项一段,按设置取
|
|
|
73
74
|
卡片之前的「看项目有哪些部署、发布」(`workflow-kinds`)查项目在这个提交上有哪几类流程,前三项只给项目有的那几类(`coda:shown`);
|
|
74
75
|
比如只有部署流程的项目,面板里只有「部署」和「全部完成后通知 Agent」。没给的那几项按不勾算。需要 Coda 745f85c 及之后。
|
|
75
76
|
另有「让 Agent 处理评审意见」:连同你的备注交给开 PR 的会话「处理你交付的评审意见」,它推送后重新评审、再请你批准,它做不了就回到批准卡;以及「关闭 PR」(`gh pr close`)。
|
|
77
|
+
- 「合并前检查」:你选了合并后,先「记下批准」的时刻,再在评审通过的提交上调用项目声明的合并前检查(`coda:kind="premerge"`)并等它们结束;
|
|
78
|
+
项目没有就直接过去。有一个没通过就交给开 PR 的会话「合并前检查没通过:处理后答复」:改动导致的就推送新提交,照常检查、评审,通过后按你这次的选择合并,不再问;
|
|
79
|
+
检查本身出了问题就处理好后答复,再跑一遍。它做不了交给你「合并前检查没通过:等你处理」。合并没成功后重试合并不再跑合并前检查(同一个提交已经通过)。
|
|
80
|
+
需要认识 `premerge` 这一类的 Coda。
|
|
76
81
|
- 「合并」(`merge.mjs`):先读 PR 现在的 base,不是默认分支就不合(Coda 下次查看 PR 时才得知 base 变了,可能晚于你批准);
|
|
77
82
|
再 `gh pr merge --<合并方式> --match-head-commit <通过的提交>`,只合评审通过(或你放行)的那个提交,分支动过 GitHub 就不合;
|
|
78
83
|
不打开 GitHub 的自动合并,它会合并之后推送、还没评审的版本。目标分支要求合并队列时,GitHub 把它放进队列。
|
|
79
84
|
- 没有合并(base 不是默认分支、冲突、要先合入目标分支、草稿、检查没过等):原因交给开 PR 的会话「合并没成功:处理后答复」。它推送新提交就照常评审,
|
|
80
85
|
通过后按你这次的选择直接合并,不再问;处理好别的(标记为可评审、等检查通过)就答复 `completed` 重试。它做不了,交给你「合并没成功:等你处理」:重试合并或关闭 PR。
|
|
81
|
-
- 批准在评审再要求修改时作废:「交叉评审」逐次接力输出最近一次要求修改的时刻 `changesAt
|
|
86
|
+
- 批准在评审再要求修改时作废:「交叉评审」逐次接力输出最近一次要求修改的时刻 `changesAt`,「记下批准」输出你批准的时刻 `at`,
|
|
82
87
|
「按原批准合并吗」只在 `at` 晚于 `changesAt` 时不再问你。
|
|
83
88
|
- 交给 GitHub 后在「等 GitHub 确认」等关闭事件,它带来合并提交;期间有新提交(被移出了合并队列)就从头再来。
|
|
84
89
|
6. **部署与发布**:合并确认后按你的勾选,在合并提交(`merge_commit_sha`)上调用其他流程:先 `run-workflows kind=deploy`,
|
|
@@ -88,7 +93,7 @@ prompts/principles/ 评审重点,一项一段,按设置取
|
|
|
88
93
|
|
|
89
94
|
- PR 在 GitHub 网页上合并或关闭(不经这条运行的「等 GitHub 确认」),运行随之结束,交出去的任务和卡片撤回,不部署、不发布。
|
|
90
95
|
- 正常结束只更新运行与卡片、结清等待,不唤醒 Agent;勾选「全部完成后通知 Agent」则在合并及所选部署、发布都结束后回传一次。未处理的失败照常回传;手动发起的评审交回结论。
|
|
91
|
-
- 流程只按检查、评审结果、PR 状态与你的批准推进,不读取作者会话的忙闲、后台任务或其他运行;合并前要先完成的验证写成检查(第 2 步)。
|
|
96
|
+
- 流程只按检查、评审结果、PR 状态与你的批准推进,不读取作者会话的忙闲、后台任务或其他运行;合并前要先完成的验证写成检查(第 2 步)或合并前检查(第 5 步)。
|
|
92
97
|
|
|
93
98
|
## 改成自己的
|
|
94
99
|
|
package/package.json
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
"name": "@coda-console/review",
|
|
3
3
|
"id": "review",
|
|
4
4
|
"displayName": "PR 生命流程",
|
|
5
|
-
"description": "会话开的 PR 从开出来起一条流程:每个新版本先跑项目声明的检查,再请另一家 Agent 评审,要求修改时交给开 PR
|
|
6
|
-
"version": "2.
|
|
5
|
+
"description": "会话开的 PR 从开出来起一条流程:每个新版本先跑项目声明的检查,再请另一家 Agent 评审,要求修改时交给开 PR 的会话处理、有分歧时交给你仲裁;通过后请你批准合并,跑过项目的合并前检查再合并,合并后按你的选择调用项目的部署、发布流程,PR 合并或关闭时结束。",
|
|
6
|
+
"version": "2.5.0",
|
|
7
7
|
"categories": ["工作流程"],
|
|
8
8
|
"extensionDependencies": [
|
|
9
9
|
"github"
|
|
@@ -120,7 +120,7 @@
|
|
|
120
120
|
}
|
|
121
121
|
}
|
|
122
122
|
},
|
|
123
|
-
"instructions": "
|
|
123
|
+
"instructions": "gh pr create 开出即评审,可与验证并行;合并要等别的 PR、升锁或发布的开草稿(-R 写在 --draft 前),说明写明前提,满足后 gh pr ready。只合并进默认分支,叠放的不合。合并前的验证写成流程步骤或 GitHub 必需检查。正常结束只更新状态,任务与失败送到本会话,不要轮询 PR;提前评审用 workflow_run 发起 pull-request,结论交回会话。"
|
|
124
124
|
},
|
|
125
125
|
"license": "MIT",
|
|
126
126
|
"repository": {
|
package/scripts/merge.mjs
CHANGED
|
@@ -5,8 +5,7 @@
|
|
|
5
5
|
// base changed only when it next looks, which may be after the user approved. Not merged (based elsewhere, a conflict, a
|
|
6
6
|
// draft, checks not passed) is no failure of the step: it is put out (`refused`, and the `reason`) for the session that
|
|
7
7
|
// opened the pull request to deal with. What the user chose
|
|
8
|
-
// to follow the merge is put out for the process (`deploy`, `release`, `releaseKinds`, `notify`)
|
|
9
|
-
// was acted on (`at`): it stands until a review asks for changes.
|
|
8
|
+
// to follow the merge is put out for the process (`deploy`, `release`, `releaseKinds`, `notify`).
|
|
10
9
|
import { spawnSync } from 'node:child_process';
|
|
11
10
|
import { baseOf, json, output, summary } from './step.mjs';
|
|
12
11
|
|
|
@@ -16,7 +15,6 @@ const chosen = id => options[id] === true;
|
|
|
16
15
|
const url = process.env.URL, head = process.env.HEAD, method = ['merge', 'rebase', 'squash'].includes(process.env.METHOD) ? process.env.METHOD : 'squash';
|
|
17
16
|
const number = /\/pull\/(\d+)/.exec(url ?? '')?.[1];
|
|
18
17
|
if (!number || !/^[0-9a-f]{40,64}$/.test(head ?? '')) { console.error('不知道要合并哪个 PR 的哪个提交'); process.exit(1); }
|
|
19
|
-
output('at', Date.now());
|
|
20
18
|
output('deploy', chosen('deploy'));
|
|
21
19
|
output('release', chosen('preview') || chosen('release'));
|
|
22
20
|
output('releaseKinds', ['preview', 'release'].filter(chosen).join(','));
|