@coda-console/review 2.6.0 → 2.7.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.
@@ -6,6 +6,7 @@
6
6
  叠放:base 不是默认分支的不合并,等 base 改过去再接着走。
7
7
  合并:请你批准,再在这个提交上调用项目声明为合并前检查的流程(coda:kind="premerge"),都通过才合并;没通过或 GitHub 没合并就交给开 PR 的会话,
8
8
  它推了新提交、评审通过后按你的批准合并,不再问。
9
+ 删除分支:你勾选后,等 GitHub 确认合并,再删除仍指向该提交的远程源分支;本地分支与工作树保留。
9
10
  部署与发布:合并后按你勾选的,在合并提交上调用项目里声明为这一类的流程(coda:kind)。
10
11
  PR 在 GitHub 上合并或关闭,运行随之结束。也可以手动发起(传 PR 编号或地址),只评审一次。BPMN 2.0,由 Coda 执行(docs/workflows.md)。 -->
11
12
  <definitions xmlns="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:coda="https://coda.pub/schema/bpmn/1.0"
@@ -286,10 +287,11 @@ GitHub 上各项检查用 `gh pr checks {{github.event.pull_request.html_url}}`
286
287
  「合并」以 {{vars.review.mergeMethod}} 方式合并提交 {{reviewing.head}}{{if kinds.premerge then ",先在它上面跑项目的合并前检查,都通过才合并" else ""}}。没合并成(合并前检查没通过,或 GitHub 没合并:冲突、检查没过等)就交给开 PR 的会话处理,它推送的新版本评审通过后按这次的选择合并,不再问你;评审要求修改则这次批准作废。</documentation>
287
288
  <extensionElements>
288
289
  <coda:choice id="merge" name="合并" primary="true">
290
+ <coda:option id="deleteBranch" name="合并后删除远程分支" detail="删除这个 PR 的远程源分支,本地分支和工作树保留" />
289
291
  <coda:option id="deploy" name="部署" detail="调用项目里的部署流程" coda:shown="=kinds.deploy" />
290
292
  <coda:option id="preview" name="发布预览版" detail="调用项目里的预览发布流程" coda:shown="=kinds.preview" />
291
293
  <coda:option id="release" name="发布正式版" detail="调用项目里的正式发布流程" coda:shown="=kinds.release" />
292
- <coda:option id="notify" name="全部完成后通知 Agent" detail="合并及所选部署、发布结束后通知" />
294
+ <coda:option id="notify" name="全部完成后通知 Agent" detail="合并及所选删除分支、部署、发布结束后通知" />
293
295
  </coda:choice>
294
296
  <coda:choice id="send" name="让 Agent 处理评审意见" />
295
297
  <coda:choice id="close" name="关闭 PR" detail="不合并,在 GitHub 上关闭这个 PR" />
@@ -367,6 +369,7 @@ GitHub 上各项检查用 `gh pr checks {{github.event.pull_request.html_url}}`
367
369
  <coda:output name="merged" />
368
370
  <coda:output name="refused" />
369
371
  <coda:output name="reason" />
372
+ <coda:output name="deleteBranch" />
370
373
  <coda:output name="deploy" />
371
374
  <coda:output name="release" />
372
375
  <coda:output name="releaseKinds" />
@@ -438,7 +441,7 @@ GitHub 上各项检查用 `gh pr checks {{github.event.pull_request.html_url}}`
438
441
  <intermediateCatchEvent id="confirmed" name="PR 关闭"><messageEventDefinition messageRef="closed" /></intermediateCatchEvent>
439
442
  <sequenceFlow id="to-landed" sourceRef="confirmed" targetRef="landed" />
440
443
  <exclusiveGateway id="landed" name="合并了吗" default="closed-unmerged" />
441
- <sequenceFlow id="landed-merged" sourceRef="landed" targetRef="delivering-or-not">
444
+ <sequenceFlow id="landed-merged" sourceRef="landed" targetRef="deleting-or-not">
442
445
  <conditionExpression xsi:type="tFormalExpression">=github.event.pull_request.merged</conditionExpression>
443
446
  </sequenceFlow>
444
447
  <sequenceFlow id="closed-unmerged" sourceRef="landed" targetRef="closed-elsewhere" />
@@ -455,6 +458,20 @@ GitHub 上各项检查用 `gh pr checks {{github.event.pull_request.html_url}}`
455
458
  <endEvent id="merged-there" coda:status="已在 GitHub 上合并" />
456
459
  <endEvent id="closed-elsewhere" coda:status="PR 已关闭" />
457
460
 
461
+ <exclusiveGateway id="deleting-or-not" name="删除远程分支吗" default="keep-branch" />
462
+ <sequenceFlow id="to-delete-branch" sourceRef="deleting-or-not" targetRef="delete-branch">
463
+ <conditionExpression xsi:type="tFormalExpression">=merge.deleteBranch</conditionExpression>
464
+ </sequenceFlow>
465
+ <sequenceFlow id="keep-branch" sourceRef="deleting-or-not" targetRef="delivering-or-not" />
466
+ <scriptTask id="delete-branch" name="删除远程分支" coda:timeout="5" coda:checkout="false" coda:status="已合并:删除远程分支" scriptFormat="bash">
467
+ <extensionElements>
468
+ <coda:env name="URL" value="=github.event.pull_request.html_url" />
469
+ <coda:env name="HEAD" value="=reviewing.head" />
470
+ </extensionElements>
471
+ <script>node "${CODA_PLUGIN_PATH}/scripts/delete-branch.mjs"</script>
472
+ </scriptTask>
473
+ <sequenceFlow id="branch-deleted" sourceRef="delete-branch" targetRef="delivering-or-not" />
474
+
458
475
  <exclusiveGateway id="delivering-or-not" name="部署或发布吗" default="merged-only" />
459
476
  <sequenceFlow id="to-delivering" sourceRef="delivering-or-not" targetRef="delivering">
460
477
  <conditionExpression xsi:type="tFormalExpression">=merge.deploy or merge.release</conditionExpression>
package/README.md CHANGED
@@ -13,6 +13,7 @@ scripts/checks.mjs 等 GitHub 检查
13
13
  scripts/review.mjs 交叉评审:选评审方、开会话、读结论、写 PR 评论
14
14
  scripts/base.mjs 看 base(叠放)
15
15
  scripts/merge.mjs 合并
16
+ scripts/delete-branch.mjs 合并确认后删除远程源分支
16
17
  scripts/notes.mjs 发布流程的参数(更新说明与 publish)
17
18
  scripts/step.mjs 各脚本共用:读参数、写输出与摘要、读 PR 的 base
18
19
  prompts/review.md 评审方收到的提示词
@@ -72,9 +73,9 @@ prompts/principles/ 评审重点,一项一段,按设置取
72
73
  仓库开了合并后删分支时,下层 PR 合并后 GitHub 自己把 base 改到默认分支;没开就由作者用 `gh pr edit --base` 改。
73
74
  5. **合并**:
74
75
  - 「批准合并」交给你,卡片写明评审结论、改动(按路径第一段分组,如 `backend/ 2 · Sources/ 1`)、PR 链接、各项检查和最近一次评审。
75
- 主按钮「合并」点按只合并;右侧箭头或长按打开勾选面板,选项是「部署」「发布预览版」「发布正式版」「全部完成后通知 Agent」,默认全不选,点面板内「合并」才提交。
76
- 卡片之前的「看项目有哪些部署、发布」(`workflow-kinds`)查项目在这个提交上有哪几类流程,前三项只给项目有的那几类(`coda:shown`);
77
- 比如只有部署流程的项目,面板里只有「部署」和「全部完成后通知 Agent」。没给的那几项按不勾算。需要 Coda 745f85c 及之后。
76
+ 主按钮「合并」点按只合并;右侧箭头或长按打开勾选面板,选项是「合并后删除远程分支」「部署」「发布预览版」「发布正式版」「全部完成后通知 Agent」,默认全不选,点面板内「合并」才提交。
77
+ 卡片之前的「看项目有哪些部署、发布」(`workflow-kinds`)查项目在这个提交上有哪几类流程,部署和发布选项只给项目有的那几类(`coda:shown`);
78
+ 比如只有部署流程的项目,面板里有「合并后删除远程分支」「部署」和「全部完成后通知 Agent」。没给的那几项按不勾算。需要 Coda 745f85c 及之后。
78
79
  另有「让 Agent 处理评审意见」:连同你的备注交给开 PR 的会话「处理你交付的评审意见」,它推送后重新评审、再请你批准,它做不了就回到批准卡;以及「关闭 PR」(`gh pr close`)。
79
80
  - 「合并前检查」:你选了合并后,先「记下批准」的时刻,再在评审通过的提交上调用项目声明的合并前检查(`coda:kind="premerge"`)并等它们结束;
80
81
  项目没有就直接过去。有一个没通过就交给开 PR 的会话「合并前检查没通过:处理后答复」:改动导致的就推送新提交,照常检查、评审,通过后按你这次的选择合并,不再问;
@@ -88,13 +89,17 @@ prompts/principles/ 评审重点,一项一段,按设置取
88
89
  - 批准在评审再要求修改时作废:「交叉评审」逐次接力输出最近一次要求修改的时刻 `changesAt`,「记下批准」输出你批准的时刻 `at`,
89
90
  「按原批准合并吗」只在 `at` 晚于 `changesAt` 时不再问你。
90
91
  - 交给 GitHub 后在「等 GitHub 确认」等关闭事件,它带来合并提交;期间有新提交(被移出了合并队列)就从头再来。
92
+ - 勾选「合并后删除远程分支」时,确认合并后、部署与发布前运行「删除远程分支」(`delete-branch.mjs`)。它从 PR 读取源仓库(包括 fork)与源分支,
93
+ 只删除仍指向这次批准合并的提交的远程分支;本地分支与会话工作树保留。分支或源仓库已删除就跳过,有了其他提交、是默认分支或合并目标分支则保留,原因记在步骤摘要。
94
+ 删除用 Git 的 `--force-with-lease=<ref>:<sha>`,推送期间分支变动也不会误删。读取或删除失败会让运行失败,处理后可从失败处继续,之后再部署与发布。
95
+ 不勾选时流程不主动删分支;GitHub 仓库自身的「合并后自动删除分支」设置仍独立生效。
91
96
  6. **部署与发布**:合并确认后按你的勾选,在合并提交(`merge_commit_sha`)上调用其他流程:先 `run-workflows kind=deploy`,
92
97
  再交给开 PR 的会话「写更新说明」(它做不了交给你写;你选「不再发布」,运行正常结束),然后按勾选调用 `kind=preview`、`release` 或 `preview,release`,
93
98
  参数 `notes`(更新说明)与 `publish`(`"true"`)。没声明某个参数的流程不会拿到它;项目没有这一类的流程,这一步直接过去。
94
99
  部署或发布失败时运行失败,结果交回开 PR 的会话,由它查明后手动重跑对应的流程。
95
100
 
96
- - PR 在 GitHub 网页上合并或关闭(不经这条运行的「等 GitHub 确认」),运行随之结束,交出去的任务和卡片撤回,不部署、不发布。
97
- - 正常结束只更新运行与卡片、结清等待,不唤醒 Agent;勾选「全部完成后通知 Agent」则在合并及所选部署、发布都结束后回传一次。未处理的失败照常回传;手动发起的评审交回结论。
101
+ - PR 在 GitHub 网页上合并或关闭(不经这条运行的「等 GitHub 确认」),运行随之结束,交出去的任务和卡片撤回,不删除分支、不部署、不发布。
102
+ - 正常结束只更新运行与卡片、结清等待,不唤醒 Agent;勾选「全部完成后通知 Agent」则在合并及所选删除分支、部署、发布都结束后回传一次。未处理的失败照常回传;手动发起的评审交回结论。
98
103
  - 流程只按检查、评审结果、PR 状态与你的批准推进,不读取作者会话的忙闲、后台任务或其他运行;合并前要先完成的验证写成检查(第 2 步)或合并前检查(第 5 步)。
99
104
 
100
105
  ## 改成自己的
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 的会话处理、有分歧时交给你仲裁;通过后请你批准合并,跑过项目的合并前检查再合并,合并后按你的选择调用项目的部署、发布流程,PR 合并或关闭时结束。",
6
- "version": "2.6.0",
5
+ "description": "会话开的 PR 从开出来起一条流程:每个新版本先跑项目声明的检查,再请另一家 Agent 评审,要求修改时交给开 PR 的会话处理、有分歧时交给你仲裁;通过后请你批准合并,跑过项目的合并前检查再合并,合并后按你的选择删除远程分支、调用项目的部署和发布流程,PR 合并或关闭时结束。",
6
+ "version": "2.7.0",
7
7
  "categories": ["工作流程"],
8
8
  "extensionDependencies": [
9
9
  "github"
@@ -0,0 +1,56 @@
1
+ // After GitHub confirms the merge, remove the source branch the user chose to delete. Read the source repository from
2
+ // the PR (it may be a fork), and lease the exact reviewed commit so later pushes cannot be deleted. An isolated bare
3
+ // repository lets the checkout-free step use Git without touching the session's local branches or worktrees.
4
+ import { spawnSync } from 'node:child_process';
5
+ import { mkdtempSync, rmSync } from 'node:fs';
6
+ import { tmpdir } from 'node:os';
7
+ import { join } from 'node:path';
8
+ import { summary } from './step.mjs';
9
+
10
+ const say = text => { console.log(text); summary(text); };
11
+ const reason = done => (done.stderr || done.stdout || done.error?.message || `退出码 ${done.status}`).trim();
12
+
13
+ let dir;
14
+ try {
15
+ const at = /^https:\/\/github\.com\/([\w.-]+\/[\w.-]+)\/pull\/(\d+)\/?$/.exec(process.env.URL ?? '');
16
+ const head = process.env.HEAD;
17
+ if (!at || !/^[0-9a-f]{40,64}$/.test(head ?? '')) throw new Error('不知道要删除哪个 PR 的哪个提交的远程分支');
18
+ const asked = spawnSync('gh', ['api', `repos/${at[1]}/pulls/${at[2]}`, '--jq',
19
+ '{merged, head: {sha: .head.sha, ref: .head.ref, repo: .head.repo.full_name, main: .head.repo.default_branch}, base: {ref: .base.ref, repo: .base.repo.full_name}}'], { encoding: 'utf8' });
20
+ if (asked.status !== 0) throw new Error(`读不到 PR:${reason(asked)}`);
21
+ const pr = JSON.parse(asked.stdout);
22
+ if (pr.merged !== true) throw new Error('PR 尚未合并');
23
+ if (!pr.head?.ref || !/^[0-9a-f]{40,64}$/.test(pr.head.sha ?? '')) throw new Error('读不到 PR 的源分支和提交');
24
+ if (pr.head.repo === null) {
25
+ say('PR 的源仓库已不存在,无需删除远程分支。');
26
+ } else if (pr.head.sha !== head) {
27
+ say('保留远程分支:PR 的源提交已变化,不是这次批准合并的提交。');
28
+ } else if (pr.head.ref === pr.head.main || (pr.head.repo === pr.base?.repo && pr.head.ref === pr.base.ref)) {
29
+ say(`保留远程分支 ${pr.head.repo}:${pr.head.ref}:它是默认分支或合并目标分支。`);
30
+ } else {
31
+ if (!/^[\w.-]+\/[\w.-]+$/.test(pr.head.repo) || !pr.head.main) throw new Error('读不到源仓库或它的默认分支');
32
+ const ref = `refs/heads/${pr.head.ref}`, remote = `https://github.com/${pr.head.repo}.git`, branch = `${pr.head.repo}:${pr.head.ref}`;
33
+ const git = (...args) => spawnSync('git', args, { cwd: dir, encoding: 'utf8' });
34
+ if (git('check-ref-format', ref).status !== 0) throw new Error('源分支名无效');
35
+ dir = mkdtempSync(join(process.env.RUNNER_TEMP || tmpdir(), 'review-delete-branch-'));
36
+ const init = git('init', '--bare', '--quiet');
37
+ if (init.status !== 0) throw new Error(`无法准备删除分支:${reason(init)}`);
38
+ const listed = git('ls-remote', '--exit-code', remote, ref);
39
+ if (listed.status === 2) {
40
+ say(`远程分支 ${branch} 已不存在,无需删除。`);
41
+ } else if (listed.status !== 0) {
42
+ throw new Error(`读不到远程分支 ${branch}:${reason(listed)}`);
43
+ } else if (listed.stdout.trim().split(/\s+/)[0] !== head) {
44
+ say(`保留远程分支 ${branch}:它已有其他提交,不再指向合并时的 ${head.slice(0, 12)}。`);
45
+ } else {
46
+ const deleted = git('push', '--porcelain', '--no-follow-tags', `--force-with-lease=${ref}:${head}`, remote, `:${ref}`);
47
+ if (deleted.status !== 0) throw new Error(`无法删除远程分支 ${branch}:${reason(deleted)}`);
48
+ say(`已删除远程分支 ${branch}(${head.slice(0, 12)})。本地分支和工作树保留。`);
49
+ }
50
+ }
51
+ } catch (error) {
52
+ const text = `删除远程分支未完成:${error.message}`;
53
+ console.error(text); summary(text); process.exitCode = 1;
54
+ } finally {
55
+ if (dir) rmSync(dir, { recursive: true, force: true });
56
+ }
package/scripts/merge.mjs CHANGED
@@ -5,7 +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`).
8
+ // to follow the merge is put out for the process (`deleteBranch`, `deploy`, `release`, `releaseKinds`, `notify`).
9
9
  import { spawnSync } from 'node:child_process';
10
10
  import { baseOf, json, output, summary } from './step.mjs';
11
11
 
@@ -15,11 +15,12 @@ const chosen = id => options[id] === true;
15
15
  const url = process.env.URL, head = process.env.HEAD, method = ['merge', 'rebase', 'squash'].includes(process.env.METHOD) ? process.env.METHOD : 'squash';
16
16
  const number = /\/pull\/(\d+)/.exec(url ?? '')?.[1];
17
17
  if (!number || !/^[0-9a-f]{40,64}$/.test(head ?? '')) { console.error('不知道要合并哪个 PR 的哪个提交'); process.exit(1); }
18
+ output('deleteBranch', chosen('deleteBranch'));
18
19
  output('deploy', chosen('deploy'));
19
20
  output('release', chosen('preview') || chosen('release'));
20
21
  output('releaseKinds', ['preview', 'release'].filter(chosen).join(','));
21
22
  output('notify', chosen('notify'));
22
- const what = ['合并', ...[['deploy', '部署'], ['preview', '发布预览版'], ['release', '发布正式版'], ['notify', '全部完成后通知 Agent']].filter(([id]) => chosen(id)).map(([, name]) => name)].join(' · ');
23
+ const what = ['合并', ...[['deleteBranch', '合并后删除远程分支'], ['deploy', '部署'], ['preview', '发布预览版'], ['release', '发布正式版'], ['notify', '全部完成后通知 Agent']].filter(([id]) => chosen(id)).map(([, name]) => name)].join(' · ');
23
24
 
24
25
  const based = await baseOf(url);
25
26
  const elsewhere = based.error ?? (based.base !== based.main ? `base 是 ${based.base},不是默认分支 ${based.main};Coda 得知 base 变了后从头再看` : null);