@coda-console/review 4.1.1 → 4.2.1

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.
@@ -114,20 +114,24 @@
114
114
  <!-- 通过:回到「开 PR 或更新」,PR 正文和批准卡换成这一轮的结论,再按那里的门去验收或合并前检查。 -->
115
115
  <sequenceFlow id="review-passed" sourceRef="verdict" targetRef="pr" />
116
116
 
117
- <!-- 第三次评审仍要求修改:不再交给主 Agent,由你决定继续修(次数清零)还是暂不合并。 -->
117
+ <!-- 第三次评审仍要求修改:不再交给主 Agent,由你决定继续修(次数清零)、不改往下走(同主 Agent 在「处理评审意见」选「不改」)还是暂不合并。 -->
118
118
  <userTask id="stuck" name="评审三轮没过" coda:assignee="user" coda:status="评审三轮没过:等你决定">
119
119
  <documentation>PR {{review.pr}} 评审了三次仍要求修改。还开着的必须修:
120
120
 
121
121
  {{review.findings}}
122
122
 
123
- 继续修:交回主 Agent 处理评审意见,重新计数。</documentation>
123
+ 选「继续修」:交回主 Agent 处理评审意见,重新计数。
124
+ 选「不改,往下走」:备注必填,写为什么放行;与主 Agent 在「处理评审意见」选「不改」同一条路:记下理由,之后只重跑检查,不再评审,然后到批准卡;理由会写进 PR 和批准卡,注明是你定的。
125
+ 选「暂不合并」:流程到此结束,不合并。</documentation>
124
126
  <extensionElements>
125
127
  <coda:choice id="more" name="继续修" primary="true" />
128
+ <coda:choice id="kept" name="不改,往下走" note="required" />
126
129
  <coda:choice id="stop" name="暂不合并" note="required" />
127
130
  </extensionElements>
128
131
  </userTask>
129
132
  <sequenceFlow id="stuck-how" sourceRef="stuck" targetRef="stuck-choice" />
130
133
  <exclusiveGateway id="stuck-choice" name="继续修吗" default="stuck-more" />
134
+ <sequenceFlow id="stuck-kept" sourceRef="stuck-choice" targetRef="kept-record"><conditionExpression xsi:type="tFormalExpression">=stuck.chose.kept</conditionExpression></sequenceFlow>
131
135
  <sequenceFlow id="stuck-stop" sourceRef="stuck-choice" targetRef="stopped"><conditionExpression xsi:type="tFormalExpression">=stuck.chose.stop</conditionExpression></sequenceFlow>
132
136
  <sequenceFlow id="stuck-more" sourceRef="stuck-choice" targetRef="again" />
133
137
  <scriptTask id="again" name="重新计数" scriptFormat="bash" coda:checkout="false" coda:timeout="5">
@@ -155,7 +159,11 @@
155
159
  <sequenceFlow id="answer-kept" sourceRef="answer-how" targetRef="kept-record"><conditionExpression xsi:type="tFormalExpression">=answer.chose.kept</conditionExpression></sequenceFlow>
156
160
  <sequenceFlow id="answer-push" sourceRef="answer-how" targetRef="push" />
157
161
  <scriptTask id="kept-record" name="记下不改的理由" scriptFormat="bash" coda:checkout="false" coda:timeout="5">
158
- <extensionElements><coda:env name="ANSWER" value="=answer" /></extensionElements>
162
+ <!-- 主 Agent 在「处理评审意见」选「不改」,或你在「评审三轮没过」选「不改,往下走」:同一步记下理由,BY 区分是谁定的。 -->
163
+ <extensionElements>
164
+ <coda:env name="ANSWER" value="=if stuck.chose.kept = true then stuck else answer" />
165
+ <coda:env name="BY" value='=if stuck.chose.kept = true then "user" else "agent"' />
166
+ </extensionElements>
159
167
  <script>node "${CODA_PLUGIN_PATH}/scripts/simple.mjs" kept</script>
160
168
  </scriptTask>
161
169
  <sequenceFlow id="kept-pr" sourceRef="kept-record" targetRef="pr" />
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  `review`:会话开的 PR 从开出来起由流程 `pull-request` 跟着走,一个 PR 一条运行,到合并或关闭才结束。
4
4
  它只用 Coda 流程的公开原语(PR 事件、Agent 步骤、人工任务、调用其他流程),也是写 PR 流程的样例:要不一样的流程,照着它改一份(见文末「改成自己的」)。
5
- 它依赖内置的 GitHub 插件(`extensionDependencies`):PR 事件由 GitHub 插件的「PR 观察」发布;装 review 时先装 GitHub 插件,卸载 GitHub 插件时 review 一起卸载。
5
+ 它依赖 Coda 自带的 GitHub 插件(`extensionDependencies`):PR 事件由 GitHub 插件的「PR 观察」发布;装 review 时先装 GitHub 插件,卸载 GitHub 插件时 review 一起卸载。
6
6
  运行的标题是「PR #号 标题」(手动发起的是参数 `pr`,评审查出 PR 后是「PR #号(地址)」),卡片上有「检查」「评审」「合并」三段;草稿、叠放的 PR 另有「草稿」「叠放」,勾了合并后流程的,合并后再有「合并后的流程」。
7
7
  流程通过 `coda:key` 声明 PR 地址为主键:在同一项目中,自动、手动发起共享一条未结束的运行,包括排队、等答复和取消收尾。地址不区分大小写。结束后新请求可再发起;旧请求重试仍返回原运行。
8
8
  也可以 `workflow_run pull-request` 手动发起(必填 `pr`:GitHub 返回的完整 PR 地址,可选 `focus`)。已有运行时返回它,沿用原进度、关注点和结果接收会话;草稿中的运行也照旧等标记为可评审。没有运行时只评审一次、不计次数、不进入合并;如果随后 PR 观察发来事件,在同一条运行里接上完整流程。是否接入完整流程按 `github.event.coda.heard` 判断:手动运行尚未收到事件时为空。
@@ -48,6 +48,8 @@ prompts/principles/ 评审重点,一项一段,按设置取
48
48
 
49
49
  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="…"/>`。
50
50
 
51
+ 4.2.0 简易开发「评审三轮没过」加第三个选项「不改,往下走」(备注必填):与主 Agent 在「处理评审意见」选「不改」走同一条路,记下理由、之后只重跑检查不再评审、到批准卡;理由写进 PR 和批准卡,注明是用户定的。
52
+
51
53
  ## 项目提供的部分
52
54
 
53
55
  插件管流程,项目在自己的仓库里提供四样,跟着代码走:
@@ -57,6 +59,9 @@ prompts/principles/ 评审重点,一项一段,按设置取
57
59
  - **合并前检查**:加入挂点 `premerge` 的流程(第 5 步),你批准后在要合并的提交上只跑一次;每个版本都跑嫌贵的验证(如整套回归)放这里。
58
60
  - **合并后的流程**:加入挂点 `merged` 的流程(第 6 步,下文「挂点 merged」),如部署、发布预览版、发布正式版。
59
61
 
62
+ PR 事件由 GitHub 插件的「PR 观察」发布;PR 合并或关闭后半小时内分支又被推送时,它立即告诉开 PR 的会话这次推送不会进目标分支。
63
+ 从运行启动到结束、结果交回,开 PR 的会话显示「等待中」,停止会话不影响流程运行及其结果交回。
64
+
60
65
  ## 流程
61
66
 
62
67
  1. **草稿**:PR 是草稿就等作者标记为可评审(`pull_request.ready_for_review`);有新提交时按它带来的草稿状态重新判断,关闭则结束。
@@ -188,7 +193,7 @@ GitHub 插件的 PR 观察看到这样的 PR,发 `foreign_pull_request.opened`
188
193
  5. **评审**:`reviewer`(或评审组合里的那一行)在只读会话里评审,规则、三种级别、评审重点与 PR 生命流程相同,结论也写成 PR 评论。只有必须修要求修改,交主 Agent「处理评审意见」:
189
194
  改了就提交、选「已修改」,流程推送、重跑检查后复评,只评上次评过的提交之后的变动并逐条核实上次还没关的必须修(同 PR 生命流程的复评);
190
195
  不改选「不改」,必须写明理由,写进 PR 和批准卡,由你批准时判断,之后不再评审。评审要求修改的次数记在 `simple.json`:第三次评审仍要求修改时不再交主 Agent,
191
- 交你「评审三轮没过」,卡上列出还开着的必须修:「继续修」回到「处理评审意见」、次数清零;「暂不合并」必须写明原因,运行结束(同批准卡的「暂不合并」)。评审通过后先回到「开 PR 或更新」,PR 正文和批准卡写的是最新一轮的结论。评审通过后再改(检查、设备验收、冲突)只重跑检查,不再评审。
196
+ 交你「评审三轮没过」,卡上列出还开着的必须修:「继续修」回到「处理评审意见」、次数清零;「不改,往下走」备注必填,写为什么放行,与主 Agent 选「不改」走同一条路(记下理由、之后只重跑检查不再评审、到批准卡),理由写进 PR 和批准卡,注明是你定的;「暂不合并」必须写明原因,运行结束(同批准卡的「暂不合并」)。评审通过后先回到「开 PR 或更新」,PR 正文和批准卡写的是最新一轮的结论。评审通过后再改(检查、设备验收、冲突)只重跑检查,不再评审。
192
197
  6. **设备验收**(`devices` 打开时):主 Agent 只装改到的那一端(`mac-preview-install`、`ios-preview-install`,传 PR 的提交),你在设备上验收;「不行」必须附言(写意见或附截图),交回主 Agent 修改,改好后重新验收。验收过的提交之后又改了,也要重新验收。
193
198
  7. **合并前检查与 GitHub 检查**:在 PR 的提交上跑一次加入挂点 `premerge` 的流程,再等 GitHub 上的检查都有结果;没通过交回主 Agent。
194
199
  8. **批准合并**:卡片上是改动汇报、评审结论、不改的理由、检查结果与 PR。「合并」按 `review.mergeMethod` 合并这个提交,可勾项目里加入挂点 `merged` 的流程(`hook-joiners` 列出,默认由各自声明)与「全部完成后通知 Agent」(默认勾选);「暂不合并」必须写明原因,交给主 Agent 跟进。合并时删除运行自己的分支;与目标分支冲突时交回主 Agent 合入、解冲突,再重跑检查、重新批准。其余合并失败让这一步失败。
@@ -253,8 +258,8 @@ PR 生命流程与简易开发声明挂点 `merged`:合并后要做的事由
253
258
 
254
259
  - **只改评审的措辞**:改 `prompts/review.md`;评审的规则在 `prompts/rules.md`,改了评审方和开 PR 的会话同时生效。
255
260
  `{{…}}` 由评审脚本换成整段文字,文件开头的注释列出各个占位(注释不发出去);只有回复末尾的 `review` 代码块是脚本读结论的约定,不能改。
256
- - **改流程**:把这个目录复制到你自己的仓库,在 Coda 的「设置 › 插件」里卸载内置的 `review`,再「从仓库添加…」装你的那份(同名替换),
257
- 之后按你的仓库更新、回退。改了插件 ID 也要先卸载内置的,否则每个 PR 会跑两条流程。
258
- - 改这里的 `review` 本身,照本仓库的规矩提 PR、升 `version`;Coda 再同步到合并后的提交(见仓库根的 README)。
261
+ - **改流程**:把这个目录复制到你自己的仓库,在 Coda 的「设置 › 插件」里「从仓库添加…」装你的那份(同名替换已装的 `review`,它是外部插件),
262
+ 之后按你的仓库更新、回退。改了插件 ID 要先卸载已装的 `review`,否则每个 PR 会跑两条流程。
263
+ - 改这里的 `review` 本身,照本仓库的规矩提 PR、升 `version`;合并并发布到 npm 后,各台 Coda 本机更新(默认自动更新,见仓库根的 README)。
259
264
 
260
265
  设备验收填写设备名时,先调用 testbed 的 `resolve-testbed` 再占用返回的组:iOS、安卓都是 `device:<设备名>` 组。此时须安装 testbed,review 不新增硬依赖。
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "displayName": "PR 生命流程",
5
5
  "description": "PR 从检查、评审到批准合并;简易开发",
6
6
  "icon": { "symbol": "checkmark.bubble.fill", "color": "purple" },
7
- "version": "4.1.1",
7
+ "version": "4.2.1",
8
8
  "categories": [
9
9
  "工作流程"
10
10
  ],
@@ -77,11 +77,12 @@ switch (action) {
77
77
  case 'again':
78
78
  save({ ...state, rounds: 0 });
79
79
  break;
80
+ // 不改的理由:主 Agent 在「处理评审意见」选的,或用户在「评审三轮没过」选的(BY 为 user),之后都只重跑检查、不再评审。
80
81
  case 'kept':
81
- save({ ...state, reviewed: true, kept: (json('ANSWER', {}).note ?? '').trim() });
82
+ save({ ...state, reviewed: true, kept: (json('ANSWER', {}).note ?? '').trim(), keptBy: env.BY });
82
83
  break;
83
84
  case 'pr': {
84
- const summary = [state.report, state.review ? `评审:${state.review.line}` : '', state.kept ? `没有照评审意见改的:\n${state.kept}` : ''].filter(Boolean).join('\n\n');
85
+ const summary = [state.report, state.review ? `评审:${state.review.line}` : '', state.kept ? `${state.keptBy === 'user' ? '评审三轮没过,用户决定不改,放行的理由' : '没有照评审意见改的'}:\n${state.kept}` : ''].filter(Boolean).join('\n\n');
85
86
  const path = join(env.RUNNER_TEMP, 'pr.md');
86
87
  writeFileSync(path, [summary, state.review?.report ? `<details><summary>评审意见</summary>\n\n${state.review.report}\n\n</details>` : ''].filter(Boolean).join('\n\n'));
87
88
  const pr = state.pr ? (gh('pr', 'edit', state.pr, '--body-file', path), state.pr)